text-compositor 0.3.0__tar.gz → 0.3.6__tar.gz

{text_compositor-0.3.0 → text_compositor-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: text-compositor
-Version: 0.3.0
+Version: 0.3.6
 Summary: A tool for composing multiple text files into a PDF document.
 License-Expression: MIT
 Project-URL: Repository, https://github.com/tokudiro/text-compositor
@@ -8,12 +8,12 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typst==0.15.0
-Requires-Dist: markdown-it-py==3.0.0
+Requires-Dist: markdown-it-py==4.2.0
 Requires-Dist: mdit-py-plugins==0.6.1
-Requires-Dist: PyYAML==6.0.2
-Requires-Dist: platformdirs==4.3.6
+Requires-Dist: PyYAML==6.0.3
+Requires-Dist: platformdirs==4.11.9
 Provides-Extra: mermaid
-Requires-Dist: playwright==1.62.0; extra == "mermaid"
+Requires-Dist: playwright==1.63.0; extra == "mermaid"
 Dynamic: license-file
 
 # text-compositor
@@ -75,6 +75,10 @@ pip install -r requirements.txt
 
 No Typst compiler binary is bundled; it's obtained from the `typst` package (PyPI wheel) installed via `pip install` above. No additional downloads or installation steps are needed.
 
+### 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.
+
 ### Using Mermaid diagrams (optional)
 
 This is only needed if your source documents use ` ```mermaid ` fences (or specify an `.mmd` file directly in `chapters`). With Option A, install the `mermaid` extra:
@@ -147,6 +151,20 @@ Other flags control runtime behavior only (not document content, which stays ent
 
 `--clean` deletes the output PDF and the intermediate files under `.text-compositor/` (`temp_build.typ`, `_template.typ`, `_common.typ`) without building. `--clean-cache` additionally deletes the diagram cache (`.text-compositor/cache/`). Input files and the config are never deleted.
 
+### Python API
+
+`text_compositor.Session` and `build_markdown()` turn a single Markdown file into a PDF without a `config.yaml`, and return warnings and errors as structured diagnostics (Markdown file and line included) instead of printing them. A resident worker (`python -m text_compositor.worker`) exposes the same over JSON lines on stdin/stdout, for GUI viewers. See the usage guide chapter "Using from Python" and section 14 of [doc/spec.md](doc/spec.md).
+
+```python
+from text_compositor import Session
+
+with Session() as session:  # reuses the Mermaid browser and the Typst compiler across builds
+    result = session.build("doc.md", "out/doc.pdf")
+    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, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz is drawn only in the Obunzu Viewer; elsewhere it is shown as code with 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.
 
 ## Trying the sample

text_compositor-0.3.0/text_compositor.egg-info/PKG-INFO → text_compositor-0.3.6/README.md

@@ -1,21 +1,3 @@
-Metadata-Version: 2.4
-Name: text-compositor
-Version: 0.3.0
-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==3.0.0
-Requires-Dist: mdit-py-plugins==0.6.1
-Requires-Dist: PyYAML==6.0.2
-Requires-Dist: platformdirs==4.3.6
-Provides-Extra: mermaid
-Requires-Dist: playwright==1.62.0; extra == "mermaid"
-Dynamic: license-file
-
 # text-compositor
 
 *[日本語版 (Japanese version)](README-ja.md)*
@@ -75,6 +57,10 @@ pip install -r requirements.txt
 
 No Typst compiler binary is bundled; it's obtained from the `typst` package (PyPI wheel) installed via `pip install` above. No additional downloads or installation steps are needed.
 
+### 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.
+
 ### Using Mermaid diagrams (optional)
 
 This is only needed if your source documents use ` ```mermaid ` fences (or specify an `.mmd` file directly in `chapters`). With Option A, install the `mermaid` extra:
@@ -147,6 +133,20 @@ Other flags control runtime behavior only (not document content, which stays ent
 
 `--clean` deletes the output PDF and the intermediate files under `.text-compositor/` (`temp_build.typ`, `_template.typ`, `_common.typ`) without building. `--clean-cache` additionally deletes the diagram cache (`.text-compositor/cache/`). Input files and the config are never deleted.
 
+### Python API
+
+`text_compositor.Session` and `build_markdown()` turn a single Markdown file into a PDF without a `config.yaml`, and return warnings and errors as structured diagnostics (Markdown file and line included) instead of printing them. A resident worker (`python -m text_compositor.worker`) exposes the same over JSON lines on stdin/stdout, for GUI viewers. See the usage guide chapter "Using from Python" and section 14 of [doc/spec.md](doc/spec.md).
+
+```python
+from text_compositor import Session
+
+with Session() as session:  # reuses the Mermaid browser and the Typst compiler across builds
+    result = session.build("doc.md", "out/doc.pdf")
+    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, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz is drawn only in the Obunzu Viewer; elsewhere it is shown as code with 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.
 
 ## Trying the sample

{text_compositor-0.3.0 → text_compositor-0.3.6}/pyproject.toml

@@ -4,23 +4,23 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "text-compositor"
-version = "0.3.0"
+version = "0.3.6"
 description = "A tool for composing multiple text files into a PDF document."
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.10"
 dependencies = [
     "typst==0.15.0",
-    "markdown-it-py==3.0.0",
+    "markdown-it-py==4.2.0",
     "mdit-py-plugins==0.6.1",
-    "PyYAML==6.0.2",
-    "platformdirs==4.3.6",
+    "PyYAML==6.0.3",
+    "platformdirs==4.11.9",
 ]
 
 # plugins.mermaid: true（既定）を使う場合のみ必要（11章）。
 # `pip install text-compositor[mermaid]` でまとめて導入できる。
 [project.optional-dependencies]
-mermaid = ["playwright==1.62.0"]
+mermaid = ["playwright==1.63.0"]
 
 [project.urls]
 Repository = "https://github.com/tokudiro/text-compositor"

text_compositor-0.3.6/tests/test_api.py

@@ -0,0 +1,330 @@
+"""Python API（api.py、#167）のテスト。実際にTypstでコンパイルするため、フォント（初回のみ取得）と、
+Typstのパッケージ（テンプレートが使う@preview/…。初回のみ取得）を使う。"""
+import os
+import struct
+import sys
+import zlib
+
+import pytest
+
+import text_compositor.build as build
+from text_compositor.deps import ensure_fonts
+import text_compositor.project as project_mod
+import time
+from text_compositor import diagnostics
+from text_compositor.api import BuildResult, Session, build_markdown
+
+
+@pytest.fixture(scope="module")
+def font_dir():
+    return ensure_fonts()
+
+
+@pytest.fixture
+def session(font_dir):
+    with Session(font_dir=font_dir) as s:
+        yield s
+
+
+def write(path, text):
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, "w", encoding="utf-8") as f:
+        f.write(text)
+
+
+def png_bytes(rgb):
+    """8x8の単色PNG（標準ライブラリだけで作る）。"""
+    def chunk(kind, data):
+        return struct.pack(">I", len(data)) + kind + data + struct.pack(">I", zlib.crc32(kind + data) & 0xFFFFFFFF)
+    raw = b"".join(b"\x00" + bytes(rgb) * 8 for _ in range(8))
+    return (b"\x89PNG\r\n\x1a\n" + chunk(b"IHDR", struct.pack(">IIBBBBB", 8, 8, 8, 2, 0, 0, 0))
+            + chunk(b"IDAT", zlib.compress(raw)) + chunk(b"IEND", b""))
+
+
+def read_bytes(path):
+    with open(path, "rb") as f:
+        return f.read()
+
+
+PLAIN = {"mermaid": False, "plantuml": False, "d2": False}
+
+
+class TestBuild:
+    def test_builds_a_pdf_to_the_requested_path(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# 見出し\n\n本文。\n\n- a\n- b\n")
+        out = tmp_path / "out" / "doc.pdf"
+        result = session.build(str(md), str(out), plugins=PLAIN)
+        assert isinstance(result, BuildResult)
+        assert result.ok and not result.errors
+        assert result.pdf_path == str(out)
+        assert read_bytes(str(out)).startswith(b"%PDF")
+
+    def test_does_not_create_an_outputs_directory_next_to_the_markdown(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        session.build(str(md), str(tmp_path / "x" / "o.pdf"), plugins=PLAIN)
+        assert not (tmp_path / "outputs").exists()
+
+    def test_default_output_is_under_the_work_directory(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        result = session.build(str(md), plugins=PLAIN)
+        assert result.ok
+        assert result.pdf_path == str(tmp_path / ".text-compositor" / "preview.pdf")
+        assert os.path.exists(result.pdf_path)
+
+    def test_leaves_no_intermediate_files_and_no_temporary_pdf(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        out = tmp_path / "out" / "doc.pdf"
+        session.build(str(md), str(out), plugins=PLAIN)
+        assert sorted(os.listdir(str(tmp_path / ".text-compositor"))) == []
+        assert sorted(os.listdir(str(out.parent))) == ["doc.pdf"]
+
+    def test_keep_temp_keeps_the_generated_typst(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN, keep_temp=True)
+        assert (tmp_path / ".text-compositor" / "temp_build.typ").exists()
+
+    def test_writes_nothing_to_stdout(self, session, tmp_path, capsys):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbefore <span>x</span> after\n")
+        session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        write(str(md), "# T\n\n```dot {width=bogus}\ndigraph { a -> b }\n```\n")
+        session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert capsys.readouterr().out == ""
+
+    def test_timings_are_reported(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert set(result.timings_ms) >= {"render", "compile", "total"}
+        assert result.timings_ms["total"] >= result.timings_ms["compile"] > 0
+
+    def test_first_markdown_heading_is_kept_as_is(self, session, tmp_path):
+        """プレビューでは、先頭のH1を落とさない（CLIの既定のcover: noneは、先頭のタイトルを落とす）。"""
+        md = tmp_path / "doc.md"
+        write(str(md), "# 先頭の見出し\n\n本文。\n")
+        session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN, keep_temp=True)
+        typst = (tmp_path / ".text-compositor" / "temp_build.typ").read_text(encoding="utf-8")
+        assert "= 先頭の見出し" in typst
+        assert "cover: false" in typst
+
+
+class TestOptions:
+    @pytest.mark.parametrize("template", ["template", "slide", "paper"])
+    def test_bundled_templates(self, session, tmp_path, template):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\n## 節\n\n本文。\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), template=template, plugins=PLAIN)
+        assert result.ok, result.diagnostics
+
+    def test_document_and_variables_overrides(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nバージョンは{{VERSION}}。\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN,
+                               document={"title": "仕様書", "toc": True}, variables={"VERSION": "1.2"},
+                               keep_temp=True)
+        assert result.ok
+        typst = (tmp_path / ".text-compositor" / "temp_build.typ").read_text(encoding="utf-8")
+        assert 'title: "仕様書"' in typst and "toc: true" in typst and "バージョンは1.2。" in typst
+
+    def test_config_override_applies_last(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN, document={"title": "A"},
+                               config={"document": {"title": "B"}}, keep_temp=True)
+        assert result.ok
+        assert 'title: "B"' in (tmp_path / ".text-compositor" / "temp_build.typ").read_text(encoding="utf-8")
+
+    def test_custom_typ_template_by_path(self, session, tmp_path):
+        """独自テンプレートは、Markdownの隣からの相対パスで指定できる。"""
+        with open(os.path.join(build.__file__ and os.path.dirname(build.__file__), "templates", "template.typ"),
+                  encoding="utf-8") as f:
+            write(str(tmp_path / "my.typ"), f.read())
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), template="my.typ", plugins=PLAIN)
+        assert result.ok, result.diagnostics
+
+
+class TestFailures:
+    def test_missing_markdown_is_reported_not_raised(self, session, tmp_path):
+        result = session.build(str(tmp_path / "none.md"), str(tmp_path / "o.pdf"))
+        assert not result.ok and result.pdf_path is None
+        assert result.errors and "not found" in result.errors[0].message
+
+    def test_unknown_template_is_reported(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), template="no_such_template", plugins=PLAIN)
+        assert not result.ok
+        assert any("Template not found" in d.message for d in result.errors)
+
+    def test_compile_error_points_at_the_markdown_line(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# 見出し\n\n```dot {width=bogus}\ndigraph { a -> b }\n```\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert not result.ok and result.pdf_path is None
+        error = result.errors[0]
+        assert "unknown variable: bogus" in error.message
+        assert error.file == str(md) and error.line == 3
+        assert error.detail and "temp_build.typ" in error.detail
+
+    def test_a_failed_build_keeps_the_previous_pdf(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        out = tmp_path / "o.pdf"
+        write(str(md), "# T\n\nok\n")
+        assert session.build(str(md), str(out), plugins=PLAIN).ok
+        before = read_bytes(str(out))
+        write(str(md), "# T\n\n```dot {width=bogus}\ndigraph { a -> b }\n```\n")
+        assert not session.build(str(md), str(out), plugins=PLAIN).ok
+        assert read_bytes(str(out)) == before
+
+    def test_the_session_recovers_after_a_failure(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\n```dot {width=bogus}\ndigraph { a -> b }\n```\n")
+        assert not session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN).ok
+        write(str(md), "# T\n\nfine\n")
+        assert session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN).ok
+
+    def test_security_violation_is_a_structured_error(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\n```typst-exec\n#panic(\"x\")\n```\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert not result.ok
+        assert any("typst-exec" in d.message and d.file == str(md) for d in result.errors)
+
+    def test_unexpected_exceptions_do_not_escape(self, session, tmp_path, monkeypatch):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n")
+
+        def boom(*a, **k):
+            raise RuntimeError("kaboom")
+        monkeypatch.setattr(project_mod, "_build_project", boom)
+        result = session.build(str(md), str(tmp_path / "o.pdf"))
+        assert not result.ok
+        assert "kaboom" in result.errors[0].message and "Traceback" in result.errors[0].detail
+
+    def test_closed_session_reports_an_error(self, font_dir, tmp_path):
+        s = Session(font_dir=font_dir)
+        s.close()
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n")
+        assert not s.build(str(md), str(tmp_path / "o.pdf")).ok
+
+    def test_output_open_elsewhere_is_reported(self, session, tmp_path, monkeypatch):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+
+        def denied(src, dst):
+            raise PermissionError("in use")
+        monkeypatch.setattr(os, "replace", denied)
+        monkeypatch.setattr(time, "sleep", lambda s: None)
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert not result.ok
+        assert any("Cannot write the PDF" in d.message for d in result.errors)
+        assert [n for n in os.listdir(str(tmp_path)) if n.startswith(".tmp-")] == []
+
+
+class TestWarnings:
+    def test_html_warning_carries_file_and_line(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\ntext\n\nbefore <span>x</span> after\n")
+        result = session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert result.ok
+        assert result.warnings
+        assert all(d.file == str(md) and d.line == 5 for d in result.warnings if "HTML" in d.message)
+
+    def test_warnings_do_not_leak_between_builds(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbefore <span>x</span>\n")
+        assert session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN).warnings
+        write(str(md), "# T\n\nclean\n")
+        assert not session.build(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN).warnings
+
+
+class TestResidentReuse:
+    def test_compiler_is_reused_and_changes_are_reflected(self, session, tmp_path):
+        md = tmp_path / "doc.md"
+        out = tmp_path / "o.pdf"
+        write(str(md), "# T\n\nfirst\n")
+        assert session.build(str(md), str(out), plugins=PLAIN).ok
+        first = read_bytes(str(out))
+        write(str(md), "# T\n\nsecond, and a bit longer text\n")
+        assert session.build(str(md), str(out), plugins=PLAIN).ok
+        assert read_bytes(str(out)) != first
+        assert len(session._compilers) == 1
+
+    def test_a_replaced_image_is_picked_up(self, session, tmp_path):
+        """同じパスの画像を差し替えても、使い回したコンパイラが古い画像を返さない。"""
+        md = tmp_path / "doc.md"
+        img = tmp_path / "img.png"
+        out = tmp_path / "o.pdf"
+        write(str(md), "# T\n\n![pic](img.png)\n")
+        img.write_bytes(png_bytes((255, 0, 0)))
+        assert session.build(str(md), str(out), plugins=PLAIN).ok
+        red = read_bytes(str(out))
+        img.write_bytes(png_bytes((0, 0, 255)))
+        assert session.build(str(md), str(out), plugins=PLAIN).ok
+        assert read_bytes(str(out)) != red
+
+    def test_different_documents_in_one_session(self, session, tmp_path):
+        a, b = tmp_path / "a" / "a.md", tmp_path / "b" / "b.md"
+        write(str(a), "# A\n\nalpha\n")
+        write(str(b), "# B\n\nbeta\n")
+        assert session.build(str(a), str(tmp_path / "a.pdf"), plugins=PLAIN).ok
+        assert session.build(str(b), str(tmp_path / "b.pdf"), plugins=PLAIN).ok
+        assert session.build(str(a), str(tmp_path / "a.pdf"), plugins=PLAIN).ok
+        assert read_bytes(str(tmp_path / "a.pdf")) != read_bytes(str(tmp_path / "b.pdf"))
+
+    def test_close_releases_everything_and_is_idempotent(self, font_dir):
+        closed = []
+
+        class FakeBrowser:
+            page = None
+
+            def close(self):
+                closed.append(1)
+        s = Session(font_dir=font_dir)
+        s._mermaid = FakeBrowser()
+        s._compilers["k"] = object()
+        s.close()
+        s.close()
+        assert closed == [1, 1] and s._compilers == {}
+
+
+class TestModuleFunction:
+    def test_build_markdown_is_a_one_shot(self, font_dir, tmp_path):
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbody\n")
+        result = build_markdown(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        assert result.ok and os.path.exists(result.pdf_path)
+
+    def test_public_names_are_importable_from_the_package(self):
+        import text_compositor
+        assert text_compositor.Session is Session
+        assert text_compositor.build_markdown is build_markdown
+        assert text_compositor.BuildResult is BuildResult
+        assert text_compositor.Diagnostic is diagnostics.Diagnostic
+        with pytest.raises(AttributeError):
+            text_compositor.nope
+
+    def test_plain_import_stays_light(self):
+        import subprocess
+        code = "import sys, text_compositor; sys.exit(1 if 'text_compositor.build' in sys.modules else 0)"
+        repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+        env = dict(os.environ, PYTHONPATH=repo_root + os.pathsep + os.environ.get("PYTHONPATH", ""))
+        assert subprocess.run([sys.executable, "-c", code], env=env, cwd=repo_root).returncode == 0
+
+    def test_result_to_dict_is_json_serializable(self, font_dir, tmp_path):
+        import json
+        md = tmp_path / "doc.md"
+        write(str(md), "# T\n\nbefore <span>x</span>\n")
+        result = build_markdown(str(md), str(tmp_path / "o.pdf"), plugins=PLAIN)
+        data = json.loads(json.dumps(result.to_dict()))
+        assert data["ok"] is True and data["pdf"] == str(tmp_path / "o.pdf")
+        assert data["diagnostics"][0]["severity"] == "warning"
+        assert set(data["timings_ms"]) >= {"render", "compile", "total"}

{text_compositor-0.3.0 → text_compositor-0.3.6}/tests/test_asset_resolution.py

@@ -6,7 +6,8 @@ import os
 
 import pytest
 
-import text_compositor.build as build
+from text_compositor.config import _resolve_project_image_path
+from text_compositor.renderer import TypstRenderer
 
 
 class TestResolveAsset:
@@ -14,7 +15,7 @@ class TestResolveAsset:
     temp_build.typの置き場所に依存しないtypst_root起点のルート絶対パスへ変換する。"""
 
     def _renderer(self, tmp_path):
-        renderer = build.TypstRenderer(line_mapping="off", base_dir=str(tmp_path), typst_root=str(tmp_path))
+        renderer = TypstRenderer(line_mapping="off", base_dir=str(tmp_path), typst_root=str(tmp_path))
         renderer.current_dir = str(tmp_path)
         renderer.current_file = str(tmp_path / "doc.md")
         return renderer
@@ -44,7 +45,7 @@ class TestResolveAsset:
         project_dir = tmp_path / "project"
         project_dir.mkdir()
         (project_dir / "a.png").write_bytes(b"\x89PNG")
-        renderer = build.TypstRenderer(line_mapping="off", base_dir=str(project_dir), typst_root=str(tmp_path))
+        renderer = TypstRenderer(line_mapping="off", base_dir=str(project_dir), typst_root=str(tmp_path))
         renderer.current_dir = str(project_dir)
         renderer.current_file = str(project_dir / "doc.md")
         assert renderer._resolve_asset("a.png") == "/project/a.png"
@@ -54,20 +55,20 @@ class TestResolveProjectImagePath:
     """document.background/logo、chapters[].background/logo（project_dir基準）の解決。"""
 
     def test_none_path_returns_none(self, tmp_path):
-        assert build._resolve_project_image_path(None, str(tmp_path), str(tmp_path), "Logo") is None
+        assert _resolve_project_image_path(None, str(tmp_path), str(tmp_path), "Logo") is None
 
     def test_existing_file_resolves_to_root_absolute_path(self, tmp_path):
         (tmp_path / "logo.png").write_bytes(b"\x89PNG")
-        result = build._resolve_project_image_path("logo.png", str(tmp_path), str(tmp_path), "Logo")
+        result = _resolve_project_image_path("logo.png", str(tmp_path), str(tmp_path), "Logo")
         assert result == "/logo.png"
 
     def test_missing_file_exits(self, tmp_path):
         with pytest.raises(SystemExit):
-            build._resolve_project_image_path("missing.png", str(tmp_path), str(tmp_path), "Logo")
+            _resolve_project_image_path("missing.png", str(tmp_path), str(tmp_path), "Logo")
 
     def test_resolves_relative_to_typst_root_not_base_dir(self, tmp_path):
         project_dir = tmp_path / "project"
         project_dir.mkdir()
         (project_dir / "logo.png").write_bytes(b"\x89PNG")
-        result = build._resolve_project_image_path("logo.png", str(project_dir), str(tmp_path), "Logo")
+        result = _resolve_project_image_path("logo.png", str(project_dir), str(tmp_path), "Logo")
         assert result == "/project/logo.png"

text_compositor-0.3.6/tests/test_check_pins.py

@@ -0,0 +1,70 @@
+"""週次の固定値確認（.github/scripts/check-pins.py。#240）のテスト。ネットワークには接続しない。"""
+import importlib.util
+import os
+
+import pytest
+
+SCRIPT = os.path.join(os.path.dirname(__file__), "..", ".github", "scripts", "check-pins.py")
+
+
+@pytest.fixture(scope="module")
+def check_pins():
+    spec = importlib.util.spec_from_file_location("check_pins", SCRIPT)
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module
+
+
+def test_read_pins_finds_every_pin_in_the_sources(check_pins):
+    """deps.py・build-dist.js・_common.typの書き方を変えたときに、確認が空振りにならないための番人。"""
+    pins = check_pins.read_pins()
+    missing = [name for name, version in pins.items() if version is None]
+    assert missing == []
+    for name in ("Mermaid", "Viz.js", "PlantUML", "D2", "Temurin JRE 21", "Noto Sans JP", "組込版Python"):
+        assert name in pins
+    assert any(name.startswith("Typstパッケージ ") for name in pins)
+
+
+def test_read_pins_matches_the_source_constants(check_pins):
+    from text_compositor import deps
+    pins = check_pins.read_pins()
+    assert pins["Viz.js"] == deps.VIZ_JS_VERSION
+    assert f"v{pins['D2']}" == deps.D2_RELEASE
+    assert f"jdk-{pins['Temurin JRE 21']}" == deps.TEMURIN_JRE_RELEASE
+
+
+@pytest.mark.parametrize("latest, current, expected", [
+    ("1.2026.8", "1.2026.6", True),
+    ("21.0.12.1+1", "21.0.12+8", True),    # 桁が多い版は、新しい（ビルド番号の大小より先に比べる）
+    ("21.0.12+8", "21.0.12.1+1", False),
+    ("3.14.7", "3.14.7", False),
+    ("3.14.10", "3.14.9", True),           # 文字列ではなく、数として比べる
+    ("v0.9.1", "0.9.0", True),
+    ("2.004", "2.004", False),
+])
+def test_is_newer(check_pins, latest, current, expected):
+    assert check_pins.is_newer(latest, current) is expected
+
+
+def test_is_major_update(check_pins):
+    assert check_pins.is_major_update("12.0.0", "11.16.1")
+    assert not check_pins.is_major_update("11.17.0", "11.16.1")
+
+
+def test_build_report_counts_updates_and_failures(check_pins):
+    pins = {"Mermaid": "11.16.1", "D2": "0.9.0", "PlantUML": "1.2026.6"}
+    latest = {
+        "Mermaid": ("12.0.0", ""),
+        "D2": ("0.9.0", ""),
+        "PlantUML": TimeoutError("timed out"),
+    }
+    report, updates, failures = check_pins.build_report(pins, latest)
+    assert (updates, failures) == (1, 1)
+    assert "**12.0.0**" in report and "メジャー更新" in report
+    assert "確認できず（TimeoutError: timed out）" in report
+
+
+def test_build_report_without_differences(check_pins):
+    report, updates, failures = check_pins.build_report({"D2": "0.9.0"}, {"D2": ("0.9.0", "")})
+    assert (updates, failures) == (0, 0)
+    assert "最新" in report

{text_compositor-0.3.0 → text_compositor-0.3.6}/tests/test_common_template.py

@@ -5,6 +5,9 @@ import re
 import pytest
 
 import text_compositor.build as build
+from text_compositor.changes import _is_up_to_date
+from text_compositor.config import _load_project_config
+from text_compositor.document import _prepare_template
 
 TOOL_DIR = os.path.dirname(os.path.abspath(build.__file__))
 TEMPLATES = os.path.join(TOOL_DIR, "templates")
@@ -59,7 +62,7 @@ class TestPrepareTemplate:
     def test_common_is_copied_next_to_template(self, env):
         project_dir, work_dir = env
         config = {"template": {"path": "template"}}
-        copy_path, _ = build._prepare_template(config, TOOL_DIR, str(project_dir), str(work_dir), str(project_dir))
+        copy_path, _ = _prepare_template(config, TOOL_DIR, str(project_dir), str(work_dir), str(project_dir))
         assert os.path.dirname(copy_path) == str(work_dir)
         assert (work_dir / "_common.typ").read_text(encoding="utf-8") == read("_common.typ")
 
@@ -68,7 +71,7 @@ class TestPrepareTemplate:
         project_dir, work_dir = env
         write(str(project_dir / "adapter.typ"), '#import "_common.typ": fit-image\n')
         config = {"template": {"path": "adapter.typ"}}
-        build._prepare_template(config, TOOL_DIR, str(project_dir), str(work_dir), str(project_dir))
+        _prepare_template(config, TOOL_DIR, str(project_dir), str(work_dir), str(project_dir))
         assert (work_dir / "_common.typ").exists()
 
 
@@ -84,12 +87,11 @@ class TestCleanRemovesCommon:
 
 
 class TestIfChangedDependsOnCommon:
-    def test_newer_common_makes_output_stale(self, tmp_path, monkeypatch):
+    def test_newer_common_makes_output_stale(self, tmp_path):
         """同梱の補助関数が更新（pip upgrade等）されたら、入力が同じでも再生成する。"""
         tool = tmp_path / "tool"
         for name in ("templates/template.typ", "templates/_common.typ", "build.py"):
             write(str(tool / name))
-        monkeypatch.setattr(build, "__file__", str(tool / "build.py"), raising=False)
         cfg = str(tmp_path / "proj" / "c.yaml")
         write(cfg, "chapters: [a.md]\n")
         pdf = str(tmp_path / "proj" / "outputs" / "System_Specification.pdf")
@@ -102,8 +104,8 @@ class TestIfChangedDependsOnCommon:
             mtime(p, 1000)
         mtime(str(tool / "templates" / "_common.typ"), 1000)
         mtime(pdf, 2000)
-        project_dir, config, _ = build._load_project_config(cfg)
-        assert build._is_up_to_date(str(tool), cfg, project_dir, config)[0] is True
+        project_dir, config, _ = _load_project_config(cfg)
+        assert _is_up_to_date(str(tool), cfg, project_dir, config)[0] is True
 
         mtime(str(tool / "templates" / "_common.typ"), 3000)
-        assert build._is_up_to_date(str(tool), cfg, project_dir, config)[0] is False
+        assert _is_up_to_date(str(tool), cfg, project_dir, config)[0] is False