text-compositor 0.4.2__tar.gz → 0.4.4__tar.gz

{text_compositor-0.4.2/text_compositor.egg-info → text_compositor-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: text-compositor
-Version: 0.4.2
+Version: 0.4.4
 Summary: A tool for composing multiple text files into a PDF document.
 License-Expression: MIT
 Project-URL: Repository, https://github.com/tokudiro/text-compositor
@@ -14,6 +14,8 @@ Requires-Dist: PyYAML==6.0.3
 Requires-Dist: platformdirs==4.11.14
 Provides-Extra: mermaid
 Requires-Dist: playwright==1.63.0; extra == "mermaid"
+Provides-Extra: highlight
+Requires-Dist: Pygments==2.21.0; extra == "highlight"
 Dynamic: license-file
 
 # text-compositor
@@ -79,7 +81,7 @@ No Typst compiler binary is bundled; it's obtained from the `typst` package (PyP
 
 ### Keeping up to date
 
-Security and bug fixes ship as new releases. There is no automatic update, so use the latest release: `pipx upgrade text-compositor` (or `pip install -U text-compositor`). For the [Obunzu Viewer](viewer/README.md), download the latest ZIP from the [Releases page](https://github.com/tokudiro/text-compositor/releases/latest). The Viewer bundles its own Python, so a new ZIP also updates that Python and the other bundled parts. A guide to using Obunzu (in Japanese) is in [doc/obunzu-guide/](doc/obunzu-guide/); its PDF is attached to each release.
+Security and bug fixes ship as new releases. There is no automatic update, so use the latest release: `pipx upgrade text-compositor` (or `pip install -U text-compositor`). For the [Obunzu Markdown Viewer](viewer/README.md), download the latest ZIP from the [Releases page](https://github.com/tokudiro/text-compositor/releases/latest). The Viewer bundles its own Python, so a new ZIP also updates that Python and the other bundled parts. A guide to using Obunzu (in Japanese) is in [doc/obunzu-guide/](doc/obunzu-guide/); its PDF is attached to each release.
 
 ### Using Mermaid diagrams (optional)
 
@@ -175,7 +177,7 @@ with Session() as session:  # reuses the Mermaid browser and the Typst compiler
     print(result.ok, result.pdf_path, [d.message for d in result.diagnostics])
 ```
 
-`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, Vega-Lite, Vega, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
+`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, finite, Vega-Lite, Vega, WaveDrom, Bytefield, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
 
 See [sample/text-compositor.config.yaml](sample/text-compositor.config.yaml) for how to write the config file, and the [usage guide](doc/usage/) for details on `document:`/`plugins:`, front matter, Marp directives, and more. The Markdown files listed in `chapters` are concatenated in order to produce the PDF.
 
@@ -192,6 +194,16 @@ This generates `sample/SampleDocument.pdf`. Two more samples show other template
 
 The core feature implemented so far is combining multiple files into a single PDF according to the config file specified via `--config` (or auto-detected). Expanding CLI options (e.g., overriding the output path) is still in the planning stage. See [GitHub Issues](https://github.com/tokudiro/text-compositor/issues) for known issues and upcoming plans.
 
+## Policy for adding diagram notations
+
+This tool is free for commercial use, runs locally, and puts no restrictions on the people who use it (see chapter 2 of [doc/spec.md](doc/spec.md)). A diagram tool or notation is therefore **not** added when it has one of these:
+
+- **A strong license constraint.** Strong copyleft such as GPL or AGPL, a watermark or credit that must stay in the output, a fee, or a usage limit.
+- **A heavy runtime.** It needs Docker or a similar container, or a large runtime that most users do not have.
+- **An external service.** It sends the manuscript to a server.
+
+Candidates that fail these checks are closed as "not planned" on [GitHub Issues](https://github.com/tokudiro/text-compositor/issues), with the reason recorded.
+
 ## License
 
 [MIT License](LICENSE)

text_compositor-0.4.2/PKG-INFO → text_compositor-0.4.4/README.md

@@ -1,21 +1,3 @@
-Metadata-Version: 2.4
-Name: text-compositor
-Version: 0.4.2
-Summary: A tool for composing multiple text files into a PDF document.
-License-Expression: MIT
-Project-URL: Repository, https://github.com/tokudiro/text-compositor
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typst==0.15.0
-Requires-Dist: markdown-it-py==4.2.0
-Requires-Dist: mdit-py-plugins==0.6.1
-Requires-Dist: PyYAML==6.0.3
-Requires-Dist: platformdirs==4.11.14
-Provides-Extra: mermaid
-Requires-Dist: playwright==1.63.0; extra == "mermaid"
-Dynamic: license-file
-
 # text-compositor
 
 *[日本語版 (Japanese version)](README-ja.md)*
@@ -79,7 +61,7 @@ No Typst compiler binary is bundled; it's obtained from the `typst` package (PyP
 
 ### Keeping up to date
 
-Security and bug fixes ship as new releases. There is no automatic update, so use the latest release: `pipx upgrade text-compositor` (or `pip install -U text-compositor`). For the [Obunzu Viewer](viewer/README.md), download the latest ZIP from the [Releases page](https://github.com/tokudiro/text-compositor/releases/latest). The Viewer bundles its own Python, so a new ZIP also updates that Python and the other bundled parts. A guide to using Obunzu (in Japanese) is in [doc/obunzu-guide/](doc/obunzu-guide/); its PDF is attached to each release.
+Security and bug fixes ship as new releases. There is no automatic update, so use the latest release: `pipx upgrade text-compositor` (or `pip install -U text-compositor`). For the [Obunzu Markdown Viewer](viewer/README.md), download the latest ZIP from the [Releases page](https://github.com/tokudiro/text-compositor/releases/latest). The Viewer bundles its own Python, so a new ZIP also updates that Python and the other bundled parts. A guide to using Obunzu (in Japanese) is in [doc/obunzu-guide/](doc/obunzu-guide/); its PDF is attached to each release.
 
 ### Using Mermaid diagrams (optional)
 
@@ -175,7 +157,7 @@ with Session() as session:  # reuses the Mermaid browser and the Typst compiler
     print(result.ok, result.pdf_path, [d.message for d in result.diagnostics])
 ```
 
-`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, Vega-Lite, Vega, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
+`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, finite, Vega-Lite, Vega, WaveDrom, Bytefield, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
 
 See [sample/text-compositor.config.yaml](sample/text-compositor.config.yaml) for how to write the config file, and the [usage guide](doc/usage/) for details on `document:`/`plugins:`, front matter, Marp directives, and more. The Markdown files listed in `chapters` are concatenated in order to produce the PDF.
 
@@ -192,6 +174,16 @@ This generates `sample/SampleDocument.pdf`. Two more samples show other template
 
 The core feature implemented so far is combining multiple files into a single PDF according to the config file specified via `--config` (or auto-detected). Expanding CLI options (e.g., overriding the output path) is still in the planning stage. See [GitHub Issues](https://github.com/tokudiro/text-compositor/issues) for known issues and upcoming plans.
 
+## Policy for adding diagram notations
+
+This tool is free for commercial use, runs locally, and puts no restrictions on the people who use it (see chapter 2 of [doc/spec.md](doc/spec.md)). A diagram tool or notation is therefore **not** added when it has one of these:
+
+- **A strong license constraint.** Strong copyleft such as GPL or AGPL, a watermark or credit that must stay in the output, a fee, or a usage limit.
+- **A heavy runtime.** It needs Docker or a similar container, or a large runtime that most users do not have.
+- **An external service.** It sends the manuscript to a server.
+
+Candidates that fail these checks are closed as "not planned" on [GitHub Issues](https://github.com/tokudiro/text-compositor/issues), with the reason recorded.
+
 ## License
 
 [MIT License](LICENSE)

{text_compositor-0.4.2 → text_compositor-0.4.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "text-compositor"
-version = "0.4.2"
+version = "0.4.4"
 description = "A tool for composing multiple text files into a PDF document."
 readme = "README.md"
 license = "MIT"
@@ -21,6 +21,8 @@ dependencies = [
 # `pip install text-compositor[mermaid]` でまとめて導入できる。
 [project.optional-dependencies]
 mermaid = ["playwright==1.63.0"]
+# HTML出力のシンタックスハイライト（#218）に使う。無くても動く（等幅の素の表示になる）。
+highlight = ["Pygments==2.21.0"]
 
 [project.urls]
 Repository = "https://github.com/tokudiro/text-compositor"
@@ -36,3 +38,8 @@ packages = ["text_compositor", "text_compositor.templates"]
 
 [tool.setuptools.package-data]
 text_compositor = ["templates/*.typ"]
+
+# 引数なしのpytestが、tests/以外（git管理外のtemp/に置いた他パッケージのテストなど）を
+# 収集して失敗しないようにする（#385）。CIは`pytest tests/`と明示している。
+[tool.pytest.ini_options]
+testpaths = ["tests"]

{text_compositor-0.4.2 → text_compositor-0.4.4}/tests/test_bundled_diagram_tools.py

@@ -149,3 +149,11 @@ def test_build_dist_pins_the_same_java_plantuml_d2_structurizr_and_mermaid_as_th
     assert deps_mod.VEGA_JS_SHA256 in script
     assert deps_mod.VEGA_LITE_JS_URL in script
     assert deps_mod.VEGA_LITE_JS_SHA256 in script
+    # WaveDrom（#392）
+    assert deps_mod.WAVEDROM_JS_URL in script
+    assert deps_mod.WAVEDROM_JS_SHA256 in script
+    assert deps_mod.WAVEDROM_SKIN_URL in script
+    assert deps_mod.WAVEDROM_SKIN_SHA256 in script
+    # Bytefield-svg（#300）
+    assert deps_mod.BYTEFIELD_JS_URL in script
+    assert deps_mod.BYTEFIELD_JS_SHA256 in script

{text_compositor-0.4.2 → text_compositor-0.4.4}/tests/test_bundled_typst_assets.py

@@ -86,10 +86,12 @@ def test_build_dist_pins_the_same_fonts_and_packages_as_the_tool():
     used.add(("kip", pikchr_render.KIP_VERSION))   # Pikchr（#213）は、テンプレートではなく、生成コードが読み込む
     # CeTZ・Fletcher（#236）・timeliney（#294）も、生成コードが読み込む。Fletcher 0.5.8が内部で使うcetz 0.3.4・oxifmt、
     # cetz 0.5.2が使うoxifmt 1.0.0、timeliney 0.4.0が使うcetz 0.4.1は、ネットワークなしで動くように、推移的な依存として、
-    # 同梱する（同梱の不足は、viewer/scripts/check-dist.jsの、オフラインでのコンパイルが検出する）
+    # 同梱する（同梱の不足は、viewer/scripts/check-dist.jsの、オフラインでのコンパイルが検出する）。
+    # finite（#292）も、生成コードが読み込む。finite 0.5.1が使うcetz 0.4.2・diagraph-layout 0.0.1・t4t 0.4.3も、同梱する
     used |= {("cetz", cetz_render.CETZ_VERSION), ("fletcher", cetz_render.FLETCHER_VERSION),
-             ("timeliney", cetz_render.TIMELINEY_VERSION),
-             ("cetz", "0.3.4"), ("cetz", cetz_render.TIMELINEY_CETZ_VERSION),
+             ("timeliney", cetz_render.TIMELINEY_VERSION), ("finite", cetz_render.FINITE_VERSION),
+             ("cetz", "0.3.4"), ("cetz", cetz_render.TIMELINEY_CETZ_VERSION), ("cetz", cetz_render.FINITE_CETZ_VERSION),
+             ("diagraph-layout", "0.0.1"), ("t4t", "0.4.3"),
              ("oxifmt", "0.2.1"), ("oxifmt", "1.0.0")}
     bundled = set(re.findall(r"name: '([a-z0-9-]+)', version: '([\d.]+)'", script))
     assert used and used == bundled, (used, bundled)

text_compositor-0.4.4/tests/test_bytefield_render.py

@@ -0,0 +1,164 @@
+"""```bytefieldフェンス（#300）のテスト。
+
+入力の検査（bytefield_render.parse_spec）は、ブラウザなしで確かめる。描画は、偽のページで、キャッシュ・無効化・エラーの扱いを確かめ、
+実ブラウザでの描画だけは、ブラウザがある環境でだけ実行する。"""
+import os
+import re
+
+import pytest
+
+from text_compositor import bytefield_render, host_renderers
+from text_compositor.api import render_html
+from text_compositor.deps import find_system_browser
+from text_compositor.renderer import TypstRenderer
+
+SOURCE = '(draw-column-headers)\n(draw-box "Source Port" {:span 16})\n(draw-box "Destination Port" {:span 16})'
+FENCE = "```bytefield\n" + SOURCE + "\n```\n"
+FAKE_SVG = '<svg xmlns="http://www.w3.org/2000/svg" width="10" height="10"></svg>'
+
+
+class TestParseSpec:
+    def test_a_source_is_returned_as_is(self):
+        assert bytefield_render.parse_spec(SOURCE) == SOURCE
+
+    @pytest.mark.parametrize("code", ["", "   \n  "])
+    def test_an_empty_source_is_rejected(self, code):
+        # Bytefield-svgは、空の入力を、エラーにせず、空の図にする。そのため、描く前に、止める。
+        with pytest.raises(bytefield_render.SpecError, match="empty"):
+            bytefield_render.parse_spec(code)
+
+
+def convert_html(tmp_path, markdown, plugins=None, name="doc.md"):
+    md = tmp_path / name
+    md.write_text(markdown, encoding="utf-8")
+    result = render_html(str(md), plugins={"mermaid": False, "plantuml": False, "d2": False, **(plugins or {})})
+    html = open(result.html_path, encoding="utf-8").read() if result.ok else ""
+    return result, html
+
+
+class FakeBytefieldPage:
+    def __init__(self, svg=FAKE_SVG, error=None):
+        self.svg, self.error, self.calls = svg, error, []
+
+    def evaluate(self, script, args):
+        self.calls.append((script, args))
+        if self.error:
+            raise self.error
+        return self.svg
+
+
+@pytest.fixture
+def fake_page(monkeypatch):
+    page = FakeBytefieldPage()
+    monkeypatch.setattr("text_compositor.mermaid.MermaidBrowser.ensure_bytefield_page", lambda self, *a: page)
+    return page
+
+
+class TestRenderWithFakePage:
+    def test_a_fence_becomes_an_svg_image_and_is_cached(self, tmp_path, fake_page):
+        result, html = convert_html(tmp_path, "# T\n\n" + FENCE)
+        assert result.ok, result.diagnostics
+        m = re.search(r'<img src="([^"]+\.svg)" alt="bytefield diagram">', html)
+        assert m
+        assert os.path.basename(m.group(1)).startswith("bytefield_")
+        assert len(fake_page.calls) == 1
+        assert fake_page.calls[0] == (bytefield_render.RENDER_SCRIPT, [SOURCE + chr(10)])   # フェンスの中身は、末尾の改行つき
+        second, _ = convert_html(tmp_path, "# T\n\n" + FENCE)
+        assert second.ok and len(fake_page.calls) == 1   # キャッシュを使い、再描画しない
+
+    def test_the_pdf_side_embeds_the_svg_with_the_requested_width(self, tmp_path, fake_page):
+        renderer = TypstRenderer(str(tmp_path), typst_root=str(tmp_path), line_mapping="off")
+        code = renderer._render_diagram_fence("bytefield", SOURCE, width="50%")
+        assert re.search(r'#image\("/.text-compositor/cache/bytefield_[0-9a-f]+\.svg", width: 50%\)', code)
+
+    def test_a_disabled_plugin_leaves_the_source_as_code(self, tmp_path, fake_page):
+        result, html = convert_html(tmp_path, "# T\n\n" + FENCE, plugins={"bytefield": False})
+        assert result.ok and "language-bytefield" in html and "<img" not in html
+        assert fake_page.calls == []
+
+    def test_an_empty_fence_fails_before_touching_the_browser(self, tmp_path, fake_page):
+        result, _ = convert_html(tmp_path, "# T\n\n```bytefield\n \n```\n")
+        assert not result.ok
+        error = [d for d in result.diagnostics if d.severity == "error"][0]
+        assert error.message == "Bytefield diagram failed to render" and error.line == 3
+        assert "empty" in error.detail
+        assert fake_page.calls == []
+
+    def test_a_rendering_failure_keeps_the_message_with_the_position(self, tmp_path, monkeypatch):
+        page = FakeBytefieldPage(error=RuntimeError(
+            "Page.evaluate: Error: draw-box called with span larger than remaining columns in row [at line 2, column 1]\n    at eval (<anonymous>:1:1)"))
+        monkeypatch.setattr("text_compositor.mermaid.MermaidBrowser.ensure_bytefield_page", lambda self, *a: page)
+        result, _ = convert_html(tmp_path, "# T\n\n" + FENCE)
+        error = [d for d in result.diagnostics if d.severity == "error"][0]
+        assert error.detail == "draw-box called with span larger than remaining columns in row [at line 2, column 1]"
+
+    def test_the_bundled_js_dir_env_is_used_without_downloading(self, tmp_path, monkeypatch):
+        from text_compositor import deps
+        (tmp_path / "lib.js").write_text("/* b */", encoding="utf-8")
+        monkeypatch.setenv(deps.BYTEFIELD_JS_DIR_ENV, str(tmp_path))
+        monkeypatch.setattr(deps, "_download", lambda *a, **k: pytest.fail("must not download"))
+        assert deps.ensure_bytefield_js() == str(tmp_path / "lib.js")
+
+    def test_a_host_renderer_is_used_instead_of_the_browser(self, tmp_path, monkeypatch):
+        calls = []
+
+        def host(diagram_id, source, script, js):
+            calls.append((diagram_id, source, script, js))
+            return FAKE_SVG
+        monkeypatch.setattr(host_renderers, "_bytefield_host_renderer", host)
+        monkeypatch.setattr("text_compositor.renderer_diagrams.ensure_bytefield_js", lambda: "lib.js")
+        result, _ = convert_html(tmp_path, "# T\n\n" + FENCE)   # ensure_bytefield_pageは、呼ばれない
+        assert result.ok, result.diagnostics
+        assert len(calls) == 1 and calls[0][1:] == (SOURCE + chr(10), bytefield_render.RENDER_SCRIPT, {"bytefield": "lib.js"})
+        assert calls[0][0].startswith("bytefield-")
+
+    def test_plugins_bytefield_is_an_allowed_config_key(self):
+        from text_compositor.config import _ALLOWED_PLUGINS_KEYS
+        assert "bytefield" in _ALLOWED_PLUGINS_KEYS
+
+    def test_a_bytefield_fence_works_inside_a_layout_block(self, tmp_path, fake_page):
+        md = "# T\n\n::: layout-right\n本文。\n\n" + FENCE + "\n:::\n"
+        result, html = convert_html(tmp_path, md)
+        assert result.ok, result.diagnostics
+        assert 'alt="bytefield diagram"' in html
+
+
+def _has_browser():
+    try:
+        import playwright  # noqa: F401
+    except ImportError:
+        return False
+    return find_system_browser() is not None
+
+
+@pytest.mark.skipif(not _has_browser(), reason="needs playwright and a system Chrome/Edge")
+class TestRealBrowser:
+    """実ブラウザで描画する（初回は、Bytefield-svgのJSを取得するため、ネットワークが要る）。"""
+
+    def test_a_packet_diagram_renders_to_svg(self, tmp_path):
+        md = tmp_path / "doc.md"
+        md.write_text("# T\n\n```bytefield\n(def boxes-per-row 32)\n(draw-box \"Source Port\" {:span 16})\n"
+                      "(draw-box \"Destination Port\" {:span 16})\n(draw-gap \"Data\")\n(draw-bottom)\n```\n", encoding="utf-8")
+        result = render_html(str(md), plugins={"mermaid": False, "plantuml": False, "d2": False})
+        assert result.ok, result.diagnostics
+        html = open(result.html_path, encoding="utf-8").read()
+        src = re.search(r'<img src="([^"]+\.svg)"', html).group(1)
+        svg = open(os.path.join(os.path.dirname(result.html_path), src), encoding="utf-8").read()
+        assert "<svg" in svg and "Source Port" in svg and "Destination Port" in svg
+
+    def test_a_drawing_error_is_reported_with_the_position(self, tmp_path):
+        md = tmp_path / "doc.md"
+        md.write_text("# T\n\n```bytefield\n(draw-box \"A\" {:span 99})\n```\n", encoding="utf-8")
+        result = render_html(str(md), plugins={"mermaid": False, "plantuml": False, "d2": False})
+        assert not result.ok
+        error = [d for d in result.diagnostics if d.severity == "error"][0]
+        assert "span larger than remaining columns" in error.detail and "[at line 1, column 1]" in error.detail
+
+    def test_javascript_interop_is_not_available_to_the_source(self, tmp_path):
+        """記述から、ブラウザの機能（通信など）には触れない。インタプリタが、`js/`の記号を解決しない。"""
+        md = tmp_path / "doc.md"
+        md.write_text("# T\n\n```bytefield\n(js/fetch \"http://example.invalid/\")\n```\n", encoding="utf-8")
+        result = render_html(str(md), plugins={"mermaid": False, "plantuml": False, "d2": False})
+        assert not result.ok
+        error = [d for d in result.diagnostics if d.severity == "error"][0]
+        assert "Could not resolve symbol: js/fetch" in error.detail

{text_compositor-0.4.2 → text_compositor-0.4.4}/tests/test_cetz_render.py

@@ -1,4 +1,4 @@
-"""CeTZ・Fletcher・timeliney（Typstのパッケージ。cetz_render.py・図のフェンスの変換、#236・#294）のテスト。"""
+"""CeTZ・Fletcher・timeliney・finite（Typstのパッケージ。cetz_render.py・図のフェンスの変換、#236・#294・#292）のテスト。"""
 import os
 import re
 
@@ -15,6 +15,7 @@ PLAIN = {"mermaid": False, "plantuml": False, "d2": False, "graphviz": False}
 CETZ = 'circle((0, 0), radius: 1)\nline((0, 0), (2, 1))\ncontent((1, 0.5), [日本語])'
 FLETCHER = 'node((0, 0), [開始]), edge("->"), node((1, 0), [終了])'
 TIMELINEY = 'headerline(group(([*2024*], 2)))\ntaskgroup(title: [日本語], {\n  task("A", (0, 1))\n})'
+FINITE = '(\n  q0: (q0: "0", q1: "1"),\n  q1: (q0: "1"),\n),\ninitial: "q0",\nfinal: ("q1",)'
 
 
 def _read(relative):
@@ -30,6 +31,8 @@ def test_the_versions_are_the_same_in_the_source_and_the_bundle():
     assert ("fletcher", cetz_render.FLETCHER_VERSION) in bundled
     assert ("timeliney", cetz_render.TIMELINEY_VERSION) in bundled
     assert ("cetz", cetz_render.TIMELINEY_CETZ_VERSION) in bundled
+    assert ("finite", cetz_render.FINITE_VERSION) in bundled
+    assert ("cetz", cetz_render.FINITE_CETZ_VERSION) in bundled
 
 
 class TestCheckCode:
@@ -80,6 +83,13 @@ class TestRender:
     def test_timeliney_becomes_an_svg(self):
         assert render_svg("timeliney", TIMELINEY).startswith("<svg")
 
+    def test_finite_becomes_an_svg(self):
+        assert render_svg("finite", FINITE).startswith("<svg")
+
+    def test_finite_scope_has_the_layouts(self):
+        """`layout.circular`など、finiteの配置を使える（Typstの`layout`関数は、eval内でだけ隠される）。"""
+        assert render_svg("finite", FINITE + ",\nlayout: layout.circular").startswith("<svg")
+
     def test_the_compiler_is_reused_and_a_later_figure_is_not_a_leftover(self):
         first = render_svg("cetz", "circle((0, 0))")
         assert render_svg("cetz", "circle((0, 0))\nline((0, 0), (3, 3))") != first
@@ -104,6 +114,7 @@ class TestRender:
         ("fletcher", 'node((0, 0), read("x"))'),
         ("fletcher", 'node((0, 0), std.plugin("x"))'),
         ("timeliney", 'task(str(read("x")), (0, 1))'),
+        ("finite", '(q0: (q1: str(read("x")))),\ninitial: "q0"'),
     ])
     def test_functions_that_read_files_are_denied_with_a_clear_message(self, kind, code):
         with pytest.raises(FigureRenderError) as e:
@@ -127,7 +138,7 @@ def _html(tmp_path, text, name="doc.md", plugins=PLAIN):
 
 
 class TestHtmlOutput:
-    @pytest.mark.parametrize("lang, code", [("cetz", CETZ), ("fletcher", FLETCHER), ("timeliney", TIMELINEY)])
+    @pytest.mark.parametrize("lang, code", [("cetz", CETZ), ("fletcher", FLETCHER), ("timeliney", TIMELINEY), ("finite", FINITE)])
     def test_a_fence_becomes_a_cached_svg_img(self, tmp_path, lang, code):
         result, html = _html(tmp_path, f'a\n\n```{lang} {{width=300pt}}\n{code}\n```\n')
         assert result.ok and not result.warnings
@@ -154,7 +165,7 @@ class TestHtmlOutput:
         assert not result.ok and "is not available" in result.errors[0].detail
         assert "TOP-SECRET" not in html
 
-    @pytest.mark.parametrize("lang", ["cetz", "fletcher", "timeliney"])
+    @pytest.mark.parametrize("lang", ["cetz", "fletcher", "timeliney", "finite"])
     def test_the_plugin_setting_falls_back_to_a_code_block_without_a_warning(self, tmp_path, lang):
         result, html = _html(tmp_path, f'```{lang}\nnode((0, 0), [x])\n```\n', plugins={**PLAIN, lang: False})
         assert result.ok and f'class="language-{lang}"' in html and not result.warnings
@@ -187,6 +198,17 @@ class TestPdfCode:
         assert 'timeliney.timeline(show-grid: true, { eval(' in code
         assert 'eval("headerline(group' in code
 
+    def test_finite_wraps_the_code_in_automaton(self):
+        code = self._render(f'```finite\n{FINITE}\n```\n')
+        assert f'import "@preview/finite:{cetz_render.FINITE_VERSION}"' in code
+        assert 'eval("automaton(\\n" + ' in code
+        assert "layout: finite.layout" in code
+        assert "measure(fig)" in code   # cetz・fletcherと同じ、自動縮小の経路
+
+    def test_a_size_attribute_on_finite_scales_to_that_size(self):
+        code = self._render(f'```finite {{width=50%}}\n{FINITE}\n```\n')
+        assert "50 * 1% * size.width" in code
+
     def test_the_file_reading_functions_are_denied_in_the_generated_code(self):
         code = self._render('```cetz\ncircle((0, 0))\n```\n')
         assert '"read", "json"' in code and "std: denied" in code
@@ -228,7 +250,7 @@ def test_a_pdf_with_both_figures_is_built(tmp_path):
     md.write_text(f'# 図\n\n```cetz\n{CETZ}\n```\n\n```fletcher\n{FLETCHER}\n```\n\n```timeliney\n{TIMELINEY}\n```\n\n'
                   '```cetz {width=5cm}\ncircle((0, 0))\n```\n\n```fletcher {width=50% height=3cm}\n'
                   'node((0, 0), [A]), edge("->"), node((1, 0), [B])\n```\n\n```timeliney {width=10cm}\n'
-                  f'{TIMELINEY}\n```\n', encoding="utf-8")
+                  f'{TIMELINEY}\n```\n\n```finite\n{FINITE}\n```\n\n```finite {{width=6cm}}\n{FINITE}\n```\n', encoding="utf-8")
     result = build_markdown(str(md), str(tmp_path / "doc.pdf"))
     assert result.ok, [(e.message, e.detail) for e in result.errors]
     assert (tmp_path / "doc.pdf").read_bytes().startswith(b"%PDF")

text_compositor-0.4.4/tests/test_diagram_alt.py

@@ -0,0 +1,105 @@
+"""図の代替テキスト（フェンスの`alt="..."`、#398）のテスト。
+
+ブラウザの要らない`svg`フェンスで、HTML・PDF（Typstのコード）の両方を確かめる。"""
+import re
+
+import pytest
+
+from text_compositor.api import render_html
+from text_compositor.renderer import TypstRenderer
+
+SVG = '<svg xmlns="http://www.w3.org/2000/svg" width="10" height="10"><rect width="10" height="10"/></svg>'
+PLAIN = {"mermaid": False, "plantuml": False, "d2": False}
+
+
+@pytest.fixture
+def renderer(tmp_path):
+    return TypstRenderer(str(tmp_path), typst_root=str(tmp_path), line_mapping="off")
+
+
+class TestParse:
+    @pytest.mark.parametrize("attrs,expected", [
+        ('{alt="ログインの流れ"}', "ログインの流れ"),
+        ("{alt='single quoted'}", "single quoted"),
+        ("{alt=word}", "word"),
+        ('{alt=""}', ""),
+        ('{width=50% alt="a b c" trim=true}', "a b c"),
+        ('{width=50%}', None),
+        ('', None),
+        (None, None),
+    ])
+    def test_the_alt_value_is_read(self, renderer, attrs, expected):
+        assert renderer._parse_alt_attr(attrs) == expected
+
+    def test_a_word_alt_inside_the_value_is_not_taken_for_another_attribute(self, renderer):
+        attrs = '{alt="width=3 and height=4 trim=true" width=50%}'
+        assert renderer._parse_alt_attr(attrs) == "width=3 and height=4 trim=true"
+        assert renderer._parse_size_attrs(attrs) == ("50%", None)
+        assert renderer._parse_trim_attr(attrs) is None
+
+    def test_sizes_and_trim_still_work_next_to_alt(self, renderer):
+        attrs = '{alt="x" width=40% height=8cm trim=false}'
+        assert renderer._parse_size_attrs(attrs) == ("40%", "8cm")
+        assert renderer._parse_trim_attr(attrs) is False
+
+
+class TestHtml:
+    def convert(self, tmp_path, attrs):
+        md = tmp_path / "doc.md"
+        md.write_text(f"# T\n\n```svg {attrs}\n{SVG}\n```\n", encoding="utf-8")
+        result = render_html(str(md), plugins=PLAIN)
+        assert result.ok, result.diagnostics
+        return open(result.html_path, encoding="utf-8").read()
+
+    def test_the_alt_becomes_the_img_alt(self, tmp_path):
+        html = self.convert(tmp_path, '{alt="ログインの流れ"}')
+        assert 'alt="ログインの流れ"' in html and 'alt="svg diagram"' not in html
+
+    def test_without_alt_the_kind_is_kept(self, tmp_path):
+        assert 'alt="svg diagram"' in self.convert(tmp_path, "")
+
+    def test_an_empty_alt_marks_the_figure_as_decorative(self, tmp_path):
+        assert 'alt=""' in self.convert(tmp_path, '{alt=""}')
+
+    def test_the_alt_is_escaped(self, tmp_path):
+        html = self.convert(tmp_path, "{alt='a <b> & \"q\"'}")
+        assert 'alt="a &lt;b&gt; &amp; &quot;q&quot;"' in html and "<b>" not in html
+
+    def test_alt_works_in_a_layout_block(self, tmp_path):
+        md = tmp_path / "doc.md"
+        md.write_text(f"# T\n\n::: layout-right\n本文。\n\n```svg {{alt=\"横並びの図\"}}\n{SVG}\n```\n\n:::\n", encoding="utf-8")
+        result = render_html(str(md), plugins=PLAIN)
+        assert result.ok, result.diagnostics
+        assert 'alt="横並びの図"' in open(result.html_path, encoding="utf-8").read()
+
+
+class TestPdfCode:
+    def test_the_alt_is_set_on_the_image_with_fit_image(self, renderer):
+        code = renderer._render_diagram_fence("svg", SVG, alt="流れ図")
+        assert re.search(r'#align\(center\)\[#\{ set image\(alt: "流れ図"\); fit-image\("[^"]+"\) \}\]', code)
+
+    def test_the_alt_is_set_on_the_image_with_an_explicit_size(self, renderer):
+        code = renderer._render_diagram_fence("svg", SVG, width="50%", alt="x")
+        assert re.search(r'set image\(alt: "x"\); image\("[^"]+", width: 50%\)', code)
+
+    def test_quotes_and_backslashes_are_escaped_for_typst(self, renderer):
+        code = renderer._render_diagram_fence("svg", SVG, alt='a "q" \\ b')
+        assert 'alt: "a \\"q\\" \\\\ b"' in code
+
+    def test_an_empty_alt_is_passed_as_an_empty_string(self, renderer):
+        assert 'set image(alt: "")' in renderer._render_diagram_fence("svg", SVG, alt="")
+
+    def test_without_alt_the_output_is_unchanged(self, renderer):
+        code = renderer._render_diagram_fence("svg", SVG)
+        assert "alt" not in code and re.search(r'#align\(center\)\[#fit-image\("[^"]+"\)\]', code)
+
+    def test_the_alt_does_not_leak_into_the_next_diagram(self, renderer):
+        renderer._render_diagram_fence("svg", SVG, alt="first")
+        assert renderer._pending_alt is None
+        assert "alt" not in renderer._render_diagram_fence("svg", SVG)
+
+    def test_the_alt_is_cleared_even_when_rendering_fails(self, renderer, monkeypatch):
+        monkeypatch.setattr(TypstRenderer, "_render_svg", lambda *a, **k: (_ for _ in ()).throw(RuntimeError("boom")))
+        with pytest.raises(RuntimeError):
+            renderer._render_diagram_fence("svg", SVG, alt="x")
+        assert renderer._pending_alt is None

{text_compositor-0.4.2 → text_compositor-0.4.4}/tests/test_distribution.py

@@ -72,12 +72,16 @@ def test_the_distribution_requirements_follow_pyproject():
     dependencies = re.search(r"^dependencies = \[(.*?)^\]", pyproject, re.S | re.M).group(1)
     project = _pins(dependencies.splitlines())
     dist = _pins((ROOT / "viewer" / "dist-requirements.txt").read_text(encoding="utf-8").splitlines())
+    # 配布物には、必須の依存に加えて、シンタックスハイライト用のPygments（`highlight`エクストラ。#218）も入れる
+    highlight = _pins(re.search(r"^highlight = \[(.*?)\]", pyproject, re.S | re.M).group(1).split(","))
+    assert highlight == {"pygments": highlight["pygments"]}
+    expected = {**project, **highlight}
 
     assert dist, "no pinned requirements found"
     for name, version in dist.items():
-        assert project.get(name) == version, f"{name}: dist {version} != pyproject {project.get(name)}"
+        assert expected.get(name) == version, f"{name}: dist {version} != pyproject {expected.get(name)}"
     # typstは、Typstを通す処理のために、同梱する（#263。#237で決めた）。Mermaid用のplaywrightは、pyprojectの必須の依存ではなく、
     # ElectronのChromiumで描画するため、同梱しない
     assert "typst" in project and "typst" in dist
     assert "playwright" not in dist
-    assert set(project) == set(dist)
+    assert set(expected) == set(dist)