3b728d9d74
WML has no horizontal rule element -- its entire %layout entity is
`<br>` -- so a thematic break was being rendered as `<p>------------</p>`,
a hardcoded twelve-dash guess at screen width that wraps into nonsense on
a narrow device and is short on a wide one. It was the one construct
where the renderer invented a width out of nothing.
A `---` already looks like a divider and reads as one in every Markdown
document ever written, so it now is one: it starts a new card, by
default. Rules are never drawn, whether or not they divide.
Thematic breaks and `{.card Title}` markers are now a single mechanism --
an explicit divider, optionally carrying a title -- and compose freely in
one document. Both still win over --split-level. A section takes its
title from its own first heading when the divider does not supply one, so
the common shape needs no titles at all:
Intro on the menu.
---
## Weather
Cold and clear.
`--no-split-on-rule` / `split_on_rule: false` opts out of the splitting;
it does not bring the dashes back.
Three edges this opened, each fixed here rather than left to bite:
- Setext headings. `Heading` over `---` is an H2 in Markdown, but the
parser was ATX-only, so it produced a paragraph plus a rule. Once a
rule divides cards, a setext document would have split at every heading
and stranded each heading as body copy on the card before it. Setext
headings are now parsed, so such a document keeps its structure.
- Empty sections. A trailing `---`, or two in a row, produced an empty
"Untitled" card and a menu entry leading to it. Sections with no
renderable content are dropped.
- The multi-card threshold was two sections, so a document with a single
divider collapsed back into one card. Any explicit divider now makes a
multi-card deck: `A --- B` asks for two screens.
Also fixes a latent frontmatter bug this made far more likely: a document
opening with `---` and no `key: value` lines had its opening swallowed as
if the break were a frontmatter fence. A fenced block with no keys in it
is not frontmatter.
222 tests. Rendering examples/trail.md still matches md2txt's committed
output byte for byte; no golden file contains an ASCII rule any more.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
176 lines
6.7 KiB
Python
176 lines
6.7 KiB
Python
"""End-to-end behaviour of the `wapdown` command."""
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
from conftest import EXAMPLES
|
|
from wapdown.cli import main
|
|
|
|
|
|
TWO_SECTIONS = "Intro.\n\n{.card One}\nFirst.\n\n{.card Two}\nSecond.\n"
|
|
|
|
|
|
@pytest.fixture
|
|
def source(tmp_path):
|
|
def _write(text: str = TWO_SECTIONS, name: str = "doc.md"):
|
|
path = tmp_path / name
|
|
path.write_text(text, encoding="utf-8")
|
|
return path
|
|
|
|
return _write
|
|
|
|
|
|
class TestOutput:
|
|
def test_writes_to_stdout_by_default(self, source, capsys):
|
|
assert main([str(source())]) == 0
|
|
assert capsys.readouterr().out.startswith('<?xml version="1.0"?>')
|
|
|
|
def test_writes_to_a_file(self, source, tmp_path):
|
|
out = tmp_path / "deck.wml"
|
|
assert main([str(source()), "-o", str(out)]) == 0
|
|
assert out.read_text(encoding="utf-8").endswith("</wml>\n")
|
|
|
|
def test_creates_missing_parent_directories(self, source, tmp_path):
|
|
out = tmp_path / "nested" / "deep" / "deck.wml"
|
|
assert main([str(source()), "-o", str(out)]) == 0
|
|
assert out.exists()
|
|
|
|
def test_uses_lf_line_endings(self, source, tmp_path):
|
|
out = tmp_path / "deck.wml"
|
|
main([str(source()), "-o", str(out)])
|
|
assert b"\r" not in out.read_bytes()
|
|
|
|
def test_deck_per_card_writes_a_directory(self, source, tmp_path):
|
|
out = tmp_path / "decks"
|
|
assert main([str(source()), "--deck-per-card", "-o", str(out)]) == 0
|
|
assert sorted(p.name for p in out.iterdir()) == [
|
|
"index.wml",
|
|
"one.wml",
|
|
"two.wml",
|
|
]
|
|
|
|
def test_deck_per_card_without_output_is_refused(self, source):
|
|
# Several files cannot be written to stdout, so say so rather than
|
|
# silently emitting only one of them.
|
|
with pytest.raises(SystemExit, match="pass -o DIRECTORY"):
|
|
main([str(source()), "--deck-per-card"])
|
|
|
|
|
|
class TestOptions:
|
|
def test_flags_reach_the_renderer(self, source, capsys):
|
|
main([str(source()), "--menu-style", "select", "--title", "Deck"])
|
|
out = capsys.readouterr().out
|
|
assert "<select" in out
|
|
assert 'title="Deck"' in out
|
|
|
|
def test_flag_overrides_frontmatter(self, source, capsys):
|
|
path = source("---\ntitle: FromFile\n---\n" + TWO_SECTIONS)
|
|
main([str(path), "--title", "FromFlag"])
|
|
assert 'title="FromFlag"' in capsys.readouterr().out
|
|
|
|
def test_frontmatter_applies_without_a_flag(self, source, capsys):
|
|
path = source("---\nmenu_style: select\n---\n" + TWO_SECTIONS)
|
|
main([str(path)])
|
|
assert "<select" in capsys.readouterr().out
|
|
|
|
def test_no_menu_switches_to_linear(self, source, capsys):
|
|
main([str(source()), "--no-menu"])
|
|
assert '<card id="menu"' not in capsys.readouterr().out
|
|
|
|
def test_frontmatter_is_not_rendered_as_content(self, source, capsys):
|
|
path = source("---\ntitle: Deck\n---\n" + TWO_SECTIONS)
|
|
main([str(path)])
|
|
assert "title: Deck" not in capsys.readouterr().out
|
|
|
|
|
|
class TestErrors:
|
|
def test_missing_input_file(self, tmp_path, capsys):
|
|
assert main([str(tmp_path / "nope.md")]) == 2
|
|
assert "wapdown:" in capsys.readouterr().err
|
|
|
|
def test_invalid_option_value(self, source, capsys):
|
|
assert main([str(source()), "--split-level", "9"]) == 2
|
|
assert "split_level" in capsys.readouterr().err
|
|
|
|
def test_invalid_frontmatter_value(self, source, capsys):
|
|
path = source("---\nsplit_level: deep\n---\n" + TWO_SECTIONS)
|
|
assert main([str(path)]) == 2
|
|
assert "must be a number" in capsys.readouterr().err
|
|
|
|
def test_unknown_menu_style_is_rejected_by_argparse(self, source):
|
|
with pytest.raises(SystemExit) as exc:
|
|
main([str(source()), "--menu-style", "carousel"])
|
|
assert exc.value.code == 2
|
|
|
|
def test_missing_include_is_reported(self, source, capsys):
|
|
path = source("Intro.\n\n{.include nowhere.md}\n")
|
|
assert main([str(path)]) == 2
|
|
assert "was not found" in capsys.readouterr().err
|
|
|
|
|
|
class TestIncludes:
|
|
def test_included_file_contributes_content(self, tmp_path, capsys):
|
|
(tmp_path / "part.md").write_text("Included body.\n", encoding="utf-8")
|
|
main([str(_write(tmp_path, "Intro.\n\n{.include part.md}\n"))])
|
|
assert "Included body." in capsys.readouterr().out
|
|
|
|
def test_included_frontmatter_is_discarded(self, tmp_path, capsys):
|
|
(tmp_path / "part.md").write_text(
|
|
"---\ntitle: Ignored\n---\nIncluded body.\n", encoding="utf-8"
|
|
)
|
|
main([str(_write(tmp_path, "Intro.\n\n{.include part.md}\n"))])
|
|
out = capsys.readouterr().out
|
|
assert "Included body." in out
|
|
assert "Ignored" not in out
|
|
|
|
def test_circular_include_is_reported(self, tmp_path, capsys):
|
|
(tmp_path / "a.md").write_text("{.include doc.md}\n", encoding="utf-8")
|
|
assert main([str(_write(tmp_path, "{.include a.md}\n"))]) == 2
|
|
assert "Circular include" in capsys.readouterr().err
|
|
|
|
|
|
def _write(directory, text: str, name: str = "doc.md"):
|
|
path = directory / name
|
|
path.write_text(text, encoding="utf-8")
|
|
return path
|
|
|
|
|
|
class TestExamples:
|
|
@pytest.mark.parametrize(
|
|
"name", sorted(p.name for p in EXAMPLES.glob("*.md"))
|
|
)
|
|
def test_every_example_converts(self, name, tmp_path, capsys):
|
|
assert main([str(EXAMPLES / name), "-o", str(tmp_path / "out.wml")]) == 0
|
|
|
|
|
|
class TestRuleDividers:
|
|
RULES = "Intro.\n\n---\n\n## Alpha\n\nBody.\n"
|
|
|
|
def test_rules_divide_by_default(self, source, capsys):
|
|
main([str(source(self.RULES))])
|
|
assert '<card id="menu"' in capsys.readouterr().out
|
|
|
|
def test_no_split_on_rule_flag(self, source, capsys):
|
|
main([str(source(self.RULES)), "--no-split-on-rule"])
|
|
out = capsys.readouterr().out
|
|
assert '<card id="menu"' not in out
|
|
assert "------" not in out
|
|
|
|
def test_frontmatter_can_disable(self, source, capsys):
|
|
path = source("---\nsplit_on_rule: false\n---\n" + self.RULES)
|
|
main([str(path)])
|
|
assert '<card id="menu"' not in capsys.readouterr().out
|
|
|
|
def test_leading_rule_without_frontmatter_keeps_content(self, source, capsys):
|
|
# Regression: a document opening with `---` and no key: value pairs
|
|
# had its opening swallowed as if it were a frontmatter fence.
|
|
main([str(source("---\n\nKept text.\n\n---\n\nAlso kept.\n"))])
|
|
out = capsys.readouterr().out
|
|
assert "Kept text." in out
|
|
assert "Also kept." in out
|
|
|
|
def test_real_frontmatter_is_still_consumed(self, source, capsys):
|
|
main([str(source("---\ntitle: Deck\n---\n\nBody.\n"))])
|
|
out = capsys.readouterr().out
|
|
assert "title: Deck" not in out
|
|
assert 'title="Deck"' not in out or "Body." in out
|