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

{text_compositor-0.2.0/text_compositor.egg-info → text_compositor-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: text-compositor
-Version: 0.2.0
+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
@@ -141,6 +141,12 @@ Run `text-compositor --check-env` (or `python build.py --check-env`) to check yo
 
 Other flags control runtime behavior only (not document content, which stays entirely in `config.yaml`): `-q`/`--quiet` suppresses `[Info]`-level logging, `-v`/`--verbose` adds extra detail (which chapter is being processed, cache reuse), and `--keep-temp` keeps the intermediate `temp_build.typ` around after a successful build instead of deleting it (useful for debugging; it's always kept after a failed build).
 
+`--watch` keeps running after the first build and rebuilds whenever it detects a save in the config, the input files, or a custom `.typ` template. A failed build does not stop it; fix the file and save again. Press Ctrl+C to stop. Changes to files outside the project directory (e.g. images referenced via `../`) are not detected.
+
+`--if-changed` skips the build, like `make`, when the output PDF is newer than the config, the input files, the template, and text-compositor itself (judged by modification time only). Without it, the PDF is always regenerated. Changes to Typst's version, to files outside the project directory, or to environment variables used by `variables` are not detected. On CI, `actions/checkout` resets every file's modification time, so restore the output directory from a cache if you want the skip to take effect.
+
+`--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.
+
 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
@@ -150,7 +156,7 @@ cd sample/
 python ../build.py
 ```
 
-This generates `sample/System_Specification.pdf`.
+This generates `sample/SampleDocument.pdf`. Two more samples show other templates: `sample/paper/` (two-column paper layout, `template.path: paper`) and `sample/universe-ilm/` (a [Typst Universe](https://typst.app/universe) template used through an adapter; needs network access on the first build).
 
 ## Implementation status
 

{text_compositor-0.2.0 → text_compositor-0.3.0}/README.md

@@ -123,6 +123,12 @@ Run `text-compositor --check-env` (or `python build.py --check-env`) to check yo
 
 Other flags control runtime behavior only (not document content, which stays entirely in `config.yaml`): `-q`/`--quiet` suppresses `[Info]`-level logging, `-v`/`--verbose` adds extra detail (which chapter is being processed, cache reuse), and `--keep-temp` keeps the intermediate `temp_build.typ` around after a successful build instead of deleting it (useful for debugging; it's always kept after a failed build).
 
+`--watch` keeps running after the first build and rebuilds whenever it detects a save in the config, the input files, or a custom `.typ` template. A failed build does not stop it; fix the file and save again. Press Ctrl+C to stop. Changes to files outside the project directory (e.g. images referenced via `../`) are not detected.
+
+`--if-changed` skips the build, like `make`, when the output PDF is newer than the config, the input files, the template, and text-compositor itself (judged by modification time only). Without it, the PDF is always regenerated. Changes to Typst's version, to files outside the project directory, or to environment variables used by `variables` are not detected. On CI, `actions/checkout` resets every file's modification time, so restore the output directory from a cache if you want the skip to take effect.
+
+`--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.
+
 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
@@ -132,7 +138,7 @@ cd sample/
 python ../build.py
 ```
 
-This generates `sample/System_Specification.pdf`.
+This generates `sample/SampleDocument.pdf`. Two more samples show other templates: `sample/paper/` (two-column paper layout, `template.path: paper`) and `sample/universe-ilm/` (a [Typst Universe](https://typst.app/universe) template used through an adapter; needs network access on the first build).
 
 ## Implementation status
 

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "text-compositor"
-version = "0.2.0"
+version = "0.3.0"
 description = "A tool for composing multiple text files into a PDF document."
 readme = "README.md"
 license = "MIT"

text_compositor-0.3.0/tests/test_common_template.py

@@ -0,0 +1,109 @@
+"""共通の補助関数`_common.typ`（#63）のリグレッションテスト。"""
+import os
+import re
+
+import pytest
+
+import text_compositor.build as build
+
+TOOL_DIR = os.path.dirname(os.path.abspath(build.__file__))
+TEMPLATES = os.path.join(TOOL_DIR, "templates")
+HELPERS = ["fit-image", "render-graph", "render-header", "render-footer", "render-background", "callout"]
+
+
+def read(name):
+    with open(os.path.join(TEMPLATES, name), encoding="utf-8") as f:
+        return f.read()
+
+
+def write(path, text="x"):
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, "w", encoding="utf-8") as f:
+        f.write(text)
+
+
+class TestBundledTemplates:
+    def test_common_defines_all_helpers(self):
+        common = read("_common.typ")
+        for name in HELPERS:
+            assert re.search(rf"^#let {re.escape(name)}\(", common, re.MULTILINE), name
+
+    def test_template_reexports_all_helpers_from_common(self):
+        """build.pyの生成コードはtemplate.typからimportするため、全補助関数が見える必要がある。"""
+        tpl = read("template.typ")
+        m = re.search(r'^#import "_common\.typ": (.+)$', tpl, re.MULTILINE)
+        assert m
+        assert set(HELPERS) <= {n.strip() for n in m.group(1).split(",")}
+
+    def test_helpers_are_not_defined_twice_in_template(self):
+        for name in ("fit-image", "render-graph", "callout", "render-background"):
+            for tpl_name in ("template.typ", "slide.typ"):
+                assert not re.search(rf"^#let {re.escape(name)}\(", read(tpl_name), re.MULTILINE), (tpl_name, name)
+
+    def test_slide_keeps_its_own_header_and_footer(self):
+        slide = read("slide.typ")
+        assert re.search(r"^#let render-header\(", slide, re.MULTILINE)
+        assert re.search(r"^#let render-footer\(", slide, re.MULTILINE)
+        m = re.search(r'^#import "_common\.typ": (.+)$', slide, re.MULTILINE)
+        assert "render-header" not in m.group(1) and "render-footer" not in m.group(1)
+
+
+class TestPrepareTemplate:
+    @pytest.fixture
+    def env(self, tmp_path):
+        project_dir = tmp_path / "proj"
+        work_dir = project_dir / ".text-compositor"
+        work_dir.mkdir(parents=True)
+        return project_dir, work_dir
+
+    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))
+        assert os.path.dirname(copy_path) == str(work_dir)
+        assert (work_dir / "_common.typ").read_text(encoding="utf-8") == read("_common.typ")
+
+    def test_common_is_copied_for_custom_typ_template(self, env):
+        """アダプタ（独自の.typ）も、隣の_common.typを相対パスで読み込める。"""
+        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))
+        assert (work_dir / "_common.typ").exists()
+
+
+class TestCleanRemovesCommon:
+    def test_clean_removes_common_copy(self, tmp_path):
+        cfg = str(tmp_path / "c.yaml")
+        write(cfg, "chapters: [a.md]\n")
+        work = tmp_path / ".text-compositor"
+        write(str(work / "_common.typ"))
+        write(str(work / "_template.typ"))
+        build._clean_one(cfg, include_cache=False)
+        assert not work.exists()
+
+
+class TestIfChangedDependsOnCommon:
+    def test_newer_common_makes_output_stale(self, tmp_path, monkeypatch):
+        """同梱の補助関数が更新（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")
+        write(pdf)
+
+        def mtime(path, sec):
+            os.utime(path, ns=(int(sec * 1e9), int(sec * 1e9)))
+
+        for p in (str(tool / "templates" / "template.typ"), str(tool / "build.py"), cfg):
+            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
+
+        mtime(str(tool / "templates" / "_common.typ"), 3000)
+        assert build._is_up_to_date(str(tool), cfg, project_dir, config)[0] is False

text_compositor-0.3.0/tests/test_diagram_cache_key.py

@@ -0,0 +1,43 @@
+"""図のキャッシュキーを複合ハッシュにする設計（#26）のリグレッションテスト。"""
+import os
+
+import text_compositor.build as build
+
+
+class TestDiagramCacheKey:
+    def test_same_inputs_give_same_key(self):
+        assert build._diagram_cache_key("d2", "v0.9.0", "a -> b") == build._diagram_cache_key("d2", "v0.9.0", "a -> b")
+
+    def test_tool_version_changes_key(self):
+        assert build._diagram_cache_key("d2", "v0.9.0", "a -> b") != build._diagram_cache_key("d2", "v0.9.1", "a -> b")
+
+    def test_code_changes_key(self):
+        assert build._diagram_cache_key("d2", "v0.9.0", "a -> b") != build._diagram_cache_key("d2", "v0.9.0", "a -> c")
+
+    def test_kind_changes_key(self):
+        assert build._diagram_cache_key("d2", "v1", "x") != build._diagram_cache_key("plantuml", "v1", "x")
+
+    def test_element_boundary_does_not_collide(self):
+        # 連結すると同じ文字列になる組み合わせでも、要素の境界が違えば別キーになる
+        assert build._diagram_cache_key("d2", "v1", "2x") != build._diagram_cache_key("d2", "v12", "x")
+
+
+class TestDiagramCachePath:
+    def test_path_contains_kind_and_key(self, tmp_path):
+        renderer = build.TypstRenderer(base_dir=str(tmp_path), line_mapping="off")
+        path, digest = renderer._diagram_cache_path("plantuml", "ver", "@startuml\n@enduml\n")
+        assert os.path.dirname(path) == str(tmp_path / ".text-compositor" / "cache")
+        assert os.path.basename(path) == f"plantuml_{digest}.svg"
+        assert os.path.isdir(os.path.dirname(path))
+
+    def test_d2_version_uses_system_d2_output(self, tmp_path, monkeypatch):
+        monkeypatch.setattr(build, "find_system_d2", lambda: "/usr/bin/d2")
+        monkeypatch.setattr(build, "_system_d2_version", lambda _bin: "v9.9.9")
+        renderer = build.TypstRenderer(base_dir=str(tmp_path), line_mapping="off")
+        assert renderer._d2_version() == "v9.9.9"
+
+    def test_d2_version_falls_back_to_pinned_release_without_downloading(self, tmp_path, monkeypatch):
+        monkeypatch.setattr(build, "find_system_d2", lambda: None)
+        monkeypatch.setattr(build, "ensure_d2_binary", lambda: (_ for _ in ()).throw(AssertionError("must not download")))
+        renderer = build.TypstRenderer(base_dir=str(tmp_path), line_mapping="off")
+        assert renderer._d2_version() == build.D2_RELEASE

text_compositor-0.3.0/tests/test_incremental.py

@@ -0,0 +1,192 @@
+"""--if-changed（更新日時による生成スキップ）と--clean/--clean-cacheのリグレッションテスト（#151）。"""
+import os
+import sys
+
+import pytest
+
+import text_compositor.build as build
+
+
+def write(path, text="x"):
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, "w", encoding="utf-8") as f:
+        f.write(text)
+
+
+def set_mtime(path, seconds):
+    ns = int(seconds * 1e9)
+    os.utime(path, ns=(ns, ns))
+
+
+@pytest.fixture
+def project(tmp_path):
+    """全入力の更新日時を1000秒、出力PDFを2000秒に固定した、ビルド済みのプロジェクト。"""
+    cfg = str(tmp_path / "text-compositor.config.yaml")
+    write(cfg, "chapters:\n  - a.md\n")
+    write(str(tmp_path / "inputs" / "a.md"), "# A\n")
+    pdf = str(tmp_path / "outputs" / "System_Specification.pdf")
+    write(pdf)
+    for p in (cfg, str(tmp_path / "inputs" / "a.md")):
+        set_mtime(p, 1000)
+    set_mtime(pdf, 2000)
+    return tmp_path, cfg, pdf
+
+
+@pytest.fixture
+def tool_dir(tmp_path_factory, monkeypatch):
+    """同梱テンプレートとbuild.py自身の更新日時を、実行時点に左右されない古い値に固定した仮のtool_dir。"""
+    d = tmp_path_factory.mktemp("tool")
+    tpl = str(d / "templates" / "template.typ")
+    write(tpl)
+    set_mtime(tpl, 500)
+    fake_build = str(d / "build.py")
+    write(fake_build)
+    set_mtime(fake_build, 500)
+    monkeypatch.setattr(build, "__file__", fake_build, raising=False)
+    return str(d)
+
+
+def check(tmp_path, cfg, tool_dir):
+    project_dir, config, _ = build._load_project_config(cfg)
+    return build._is_up_to_date(tool_dir, cfg, project_dir, config)
+
+
+class TestIsUpToDate:
+    def test_up_to_date_when_output_is_newest(self, project, tool_dir):
+        tmp_path, cfg, pdf = project
+        up_to_date, out = check(tmp_path, cfg, tool_dir)
+        assert up_to_date
+        assert out == os.path.normpath(pdf)
+
+    def test_stale_when_output_missing(self, project, tool_dir):
+        tmp_path, cfg, pdf = project
+        os.remove(pdf)
+        assert check(tmp_path, cfg, tool_dir)[0] is False
+
+    @pytest.mark.parametrize("rel", ["text-compositor.config.yaml", os.path.join("inputs", "a.md")])
+    def test_stale_when_input_or_config_is_newer(self, project, tool_dir, rel):
+        tmp_path, cfg, pdf = project
+        set_mtime(str(tmp_path / rel), 3000)
+        assert check(tmp_path, cfg, tool_dir)[0] is False
+
+    def test_stale_when_new_input_file_is_added(self, project, tool_dir):
+        tmp_path, cfg, pdf = project
+        b = str(tmp_path / "inputs" / "b.csv")
+        write(b)
+        set_mtime(b, 3000)
+        assert check(tmp_path, cfg, tool_dir)[0] is False
+
+    def test_stale_when_custom_typ_template_is_newer(self, tmp_path, tool_dir):
+        cfg = str(tmp_path / "c.yaml")
+        write(cfg, "template:\n  path: my/tpl.typ\nchapters: [a.md]\n")
+        tpl = str(tmp_path / "my" / "tpl.typ")
+        write(tpl)
+        pdf = str(tmp_path / "outputs" / "System_Specification.pdf")
+        write(pdf)
+        set_mtime(cfg, 1000)
+        set_mtime(tpl, 3000)
+        set_mtime(pdf, 2000)
+        assert check(tmp_path, cfg, tool_dir)[0] is False
+
+    def test_stale_when_tool_is_newer(self, project, tool_dir):
+        tmp_path, cfg, pdf = project
+        set_mtime(build.__file__, 3000)
+        assert check(tmp_path, cfg, tool_dir)[0] is False
+
+    def test_intermediate_files_do_not_make_it_stale(self, project, tool_dir):
+        tmp_path, cfg, pdf = project
+        tmp_file = str(tmp_path / ".text-compositor" / "temp_build.typ")
+        write(tmp_file)
+        set_mtime(tmp_file, 3000)
+        assert check(tmp_path, cfg, tool_dir)[0] is True
+
+    def test_other_pdf_in_project_dir_is_ignored(self, project, tool_dir):
+        """--config-listで同じproject_dirを共有する別configのPDFで、互いに常に再生成にならないこと。"""
+        tmp_path, cfg, pdf = project
+        other = str(tmp_path / "other_outputs" / "other.pdf")
+        write(other)
+        set_mtime(other, 9000)
+        assert check(tmp_path, cfg, tool_dir)[0] is True
+
+
+class TestBuildOneSkips:
+    def test_skip_logs_and_does_not_touch_work_dir(self, project, tool_dir, capsys, monkeypatch):
+        tmp_path, cfg, pdf = project
+        monkeypatch.setattr(build, "_is_up_to_date", lambda *a: (True, pdf))
+        # スキップ時はrepo_root/font_dirを使わない。触ればNoneで即座に失敗する。
+        build._build_one(tool_dir, None, None, cfg, if_changed=True)
+        assert "Skipped (up to date)" in capsys.readouterr().out
+        assert not (tmp_path / ".text-compositor").exists()
+
+    def test_without_flag_never_checks_freshness(self, project, tool_dir, monkeypatch):
+        tmp_path, cfg, pdf = project
+
+        def boom(*a):
+            raise AssertionError("checked")
+        monkeypatch.setattr(build, "_is_up_to_date", boom)
+        # 既定は従来どおり常に再生成する。判定関数は呼ばれず、後続の処理（ここでは_resolve_variables以降）へ進む。
+        monkeypatch.setattr(build, "_resolve_variables", lambda c: (_ for _ in ()).throw(RuntimeError("proceeded")))
+        with pytest.raises(RuntimeError, match="proceeded"):
+            build._build_one(tool_dir, None, None, cfg)
+
+
+class TestClean:
+    @pytest.fixture
+    def built(self, project):
+        tmp_path, cfg, pdf = project
+        work = tmp_path / ".text-compositor"
+        write(str(work / "temp_build.typ"))
+        write(str(work / "_template.typ"))
+        write(str(work / "cache" / "svg_abc.svg"))
+        return tmp_path, cfg, pdf, work
+
+    def test_clean_removes_pdf_and_intermediates_but_keeps_cache(self, built):
+        tmp_path, cfg, pdf, work = built
+        build._clean_one(cfg, include_cache=False)
+        assert not os.path.exists(pdf)
+        assert not (work / "temp_build.typ").exists()
+        assert not (work / "_template.typ").exists()
+        assert (work / "cache" / "svg_abc.svg").exists()
+
+    def test_clean_cache_also_removes_cache_and_empty_work_dir(self, built):
+        tmp_path, cfg, pdf, work = built
+        build._clean_one(cfg, include_cache=True)
+        assert not os.path.exists(pdf)
+        assert not work.exists()
+
+    def test_inputs_and_config_are_never_removed(self, built):
+        tmp_path, cfg, pdf, work = built
+        build._clean_one(cfg, include_cache=True)
+        assert os.path.exists(cfg)
+        assert (tmp_path / "inputs" / "a.md").exists()
+
+    def test_clean_is_noop_when_nothing_to_remove(self, project, capsys):
+        tmp_path, cfg, pdf = project
+        os.remove(pdf)
+        build._clean_one(cfg, include_cache=True)
+        assert "Cleaned 0 item(s)" in capsys.readouterr().out
+
+
+class TestArgs:
+    def parse(self, monkeypatch, *argv):
+        monkeypatch.setattr(sys, "argv", ["text-compositor", *argv])
+        return build.parse_args()
+
+    def test_clean_cache_implies_clean(self, monkeypatch):
+        args = self.parse(monkeypatch, "--clean-cache")
+        assert args.clean and args.clean_cache
+
+    def test_defaults_keep_existing_behavior(self, monkeypatch):
+        args = self.parse(monkeypatch)
+        assert not args.if_changed and not args.clean
+
+    @pytest.mark.parametrize("extra", [["--watch"], ["--if-changed"], ["--check-env"]])
+    def test_clean_conflicts(self, monkeypatch, extra):
+        with pytest.raises(SystemExit) as e:
+            self.parse(monkeypatch, "--clean", *extra)
+        assert e.value.code == 2
+
+    def test_if_changed_conflicts_with_watch(self, monkeypatch):
+        with pytest.raises(SystemExit) as e:
+            self.parse(monkeypatch, "--if-changed", "--watch")
+        assert e.value.code == 2

text_compositor-0.3.0/tests/test_paper_template.py

@@ -0,0 +1,84 @@
+"""論文形式テンプレート`paper`と`document.abstract`（#64）のリグレッションテスト。"""
+import os
+import re
+
+import pytest
+
+import text_compositor.build as build
+
+TOOL_DIR = os.path.dirname(os.path.abspath(build.__file__))
+
+
+def read_template(name):
+    with open(os.path.join(TOOL_DIR, "templates", name), encoding="utf-8") as f:
+        return f.read()
+
+
+class TestResolveAbstract:
+    def test_unset_returns_none(self):
+        assert build._resolve_abstract({}) is None
+
+    def test_blank_returns_none(self):
+        assert build._resolve_abstract({"abstract": "  \n "}) is None
+
+    def test_string_is_stripped(self):
+        assert build._resolve_abstract({"abstract": "\n本文。\n"}) == "本文。"
+
+    @pytest.mark.parametrize("value", [["a", "b"], {"k": "v"}, 3, True])
+    def test_non_string_is_an_error(self, value, capsys):
+        with pytest.raises(SystemExit) as e:
+            build._resolve_abstract({"abstract": value})
+        assert e.value.code == 1
+        assert "document.abstract must be a string" in capsys.readouterr().out
+
+
+class TestAbstractTypstArg:
+    def test_none_passes_no_argument(self):
+        assert build._abstract_typst_arg(None) == ""
+
+    def test_multiline_is_one_line_literal_with_escaped_newline(self):
+        arg = build._abstract_typst_arg("一行目\n二行目")
+        assert arg == '  abstract: "一行目\\n二行目",\n'
+
+    def test_markup_characters_are_data_not_markup(self):
+        arg = build._abstract_typst_arg('#import "x" *bold*')
+        assert '\\"x\\"' in arg and arg.startswith('  abstract: "')
+
+    def test_crlf_is_normalized(self):
+        assert "\\r" not in build._abstract_typst_arg("a\r\nb") and "\r" not in build._abstract_typst_arg("a\r\nb")
+
+
+class TestPreamble:
+    def preamble(self, doc):
+        return build._build_document_preamble({"document": doc}, "/t.typ", True, ".", ".")[0]
+
+    def test_abstract_is_passed_only_when_set(self):
+        assert "abstract:" not in self.preamble({"title": "T"})
+        assert 'abstract: "概要",' in self.preamble({"title": "T", "abstract": "概要"})
+
+
+class TestPaperTemplate:
+    def test_bundled_name_resolves(self):
+        path = build.resolve_template_path("paper", TOOL_DIR, ".")
+        assert os.path.exists(path)
+
+    def test_conf_accepts_every_required_argument(self):
+        """build.pyが常に渡す引数を受け取れないと、そのテンプレートは常にビルドエラーになる。"""
+        conf = read_template("paper.typ").split("#let conf(")[1].split(") = {")[0]
+        for arg in ["title", "subtitle", "author", "date", "paper_size", "landscape", "graphviz",
+                    "header", "footer", "paginate", "background", "logo"]:
+            assert re.search(rf"^\s*{arg}:", conf, re.MULTILINE), arg
+
+    @pytest.mark.parametrize("name", ["paper.typ", "template.typ", "slide.typ"])
+    def test_every_bundled_template_accepts_abstract(self, name):
+        conf = read_template(name).split("#let conf(")[1].split(") = {")[0]
+        assert re.search(r"^\s*abstract:", conf, re.MULTILINE)
+
+    def test_paper_exports_all_helpers_via_common(self):
+        m = re.search(r'^#import "_common\.typ": (.+)$', read_template("paper.typ"), re.MULTILINE)
+        names = {n.strip() for n in m.group(1).split(",")}
+        assert {"fit-image", "render-graph", "callout", "render-header", "render-footer",
+                "render-background"} <= names
+
+    def test_paper_is_two_columns(self):
+        assert "columns: 2" in read_template("paper.typ")

text_compositor-0.3.0/tests/test_revision_history.py

@@ -0,0 +1,83 @@
+"""改版履歴ページ（document.revision_history、#56）のリグレッションテスト。"""
+import datetime
+
+import pytest
+
+import text_compositor.build as build
+
+
+def resolve(entries):
+    return build._resolve_revision_history({"revision_history": entries})
+
+
+class TestResolve:
+    def test_absent_or_empty_disables_the_page(self):
+        assert build._resolve_revision_history({}) is None
+        assert resolve([]) is None
+
+    def test_fills_missing_keys_with_empty_strings(self):
+        assert resolve([{"version": "1.0", "description": "初版"}]) == [
+            {"version": "1.0", "date": "", "description": "初版", "author": ""}]
+
+    def test_values_are_stringified_including_yaml_dates(self):
+        out = resolve([{"version": 2, "date": datetime.date(2026, 8, 1), "description": None}])
+        assert out == [{"version": "2", "date": "2026-08-01", "description": "", "author": ""}]
+
+    def test_order_is_preserved(self):
+        out = resolve([{"version": "1.0"}, {"version": "1.1"}])
+        assert [e["version"] for e in out] == ["1.0", "1.1"]
+
+    @pytest.mark.parametrize("bad", [
+        "1.0",
+        {"version": "1.0"},
+        ["1.0"],
+        [{"version": "1", "discription": "typo"}],
+        [{}],
+        [{"version": " ", "description": ""}],
+    ])
+    def test_invalid_definitions_are_fatal(self, bad, capsys):
+        with pytest.raises(SystemExit) as e:
+            resolve(bad)
+        assert e.value.code == 1
+        assert "revision_history" in capsys.readouterr().out
+
+
+class TestTypstArg:
+    def test_none_passes_no_argument(self):
+        # 引数を持たない既存の独自テンプレートとの互換のため、引数行自体を出さない
+        assert build._revision_history_typst_arg(None) == ""
+
+    def test_single_entry_is_still_an_array(self):
+        arg = build._revision_history_typst_arg(resolve([{"version": "1.0"}]))
+        assert arg == '  revision_history: ((version: "1.0", date: "", description: "", author: ""),),\n'
+
+    def test_multiple_entries(self):
+        arg = build._revision_history_typst_arg(resolve([{"version": "1.0"}, {"version": "1.1"}]))
+        assert arg.count("(version:") == 2
+
+    def test_quotes_backslashes_and_markup_are_escaped_as_string_data(self):
+        arg = build._revision_history_typst_arg(resolve([{"description": 'say "hi" \\ #x *y*'}]))
+        assert 'description: "say \\"hi\\" \\\\ #x *y*"' in arg
+
+    def test_newlines_become_escape_sequences_not_raw_line_breaks(self):
+        arg = build._revision_history_typst_arg(resolve([{"description": "a\r\nb\nc"}]))
+        assert 'description: "a\\nb\\nc"' in arg
+        assert arg.count("\n") == 1  # 引数行末の改行のみ
+
+
+class TestPreamble:
+    def build_preamble(self, doc):
+        preamble, *_ = build._build_document_preamble({"document": doc}, "/t.typ", True, "/proj", "/proj")
+        return preamble
+
+    def test_argument_is_passed_to_conf_when_configured(self):
+        pre = self.build_preamble({"revision_history": [{"version": "1.0", "description": "初版"}]})
+        assert 'revision_history: ((version: "1.0", date: "", description: "初版", author: ""),),' in pre
+
+    def test_no_argument_when_not_configured(self):
+        assert "revision_history" not in self.build_preamble({})
+        assert "revision_history" not in self.build_preamble({"revision_history": []})
+
+    def test_argument_is_placed_among_the_optional_arguments(self):
+        pre = self.build_preamble({"toc": True, "revision_history": [{"version": "1"}]})
+        assert pre.index("toc: true") < pre.index("revision_history:") < pre.index("graphviz:")