workstream-cli 0.0.1__py3-none-any.whl

workstream/test/test_markdown.py

@@ -0,0 +1,626 @@
+"""Tests for workstream.markdown — frontmatter, sections, load/save round-trip."""
+
+from pathlib import Path
+
+from workstream.markdown import (
+    append_idea,
+    append_log_entry,
+    append_thought,
+    append_thread_entry,
+    get_section,
+    load_workstream,
+    parse_branches,
+    parse_decisions,
+    parse_frontmatter,
+    parse_ideas,
+    parse_log,
+    parse_next_actions,
+    parse_plans,
+    parse_thread,
+    parse_thoughts,
+    render_body,
+    save_workstream,
+    set_section,
+    write_frontmatter,
+)
+from workstream.models import (
+    BranchRef,
+    IdeaEntry,
+    LogEntry,
+    PlanRef,
+    ThoughtEntry,
+    ThreadEntry,
+    Workstream,
+)
+
+# ---------------------------------------------------------------------------
+# Sample data
+# ---------------------------------------------------------------------------
+
+_SAMPLE_FRONTMATTER = """\
+---
+id: '2026-03-28-abc1234567'
+title: Test Stream
+status: active
+size: day
+tags:
+- infra
+- backend
+repos:
+- my-repo
+created: '2026-01-15'
+updated: '2026-03-28'
+---
+
+"""
+
+_SAMPLE_BODY = """\
+# Test Stream
+
+#infra #backend
+
+## Thread
+### 2026-03-28
+Did some work today.
+
+Multi-line body here.
+
+### 2026-03-27
+Started the project.
+
+## Decisions
+- Use Python 3.11+
+- Adopt face for CLI
+
+## Plans
+- my-repo `.plans/migrate.md` (active)
+
+## Branches
+- my-repo: `feature/ws-cli` (+3 ahead)
+
+## Next
+- Write tests
+- Ship v1
+"""
+
+
+# ---------------------------------------------------------------------------
+# Frontmatter
+# ---------------------------------------------------------------------------
+
+
+def test_parse_frontmatter_basic():
+    meta, body = parse_frontmatter(_SAMPLE_FRONTMATTER)
+    assert meta["id"] == "2026-03-28-abc1234567"
+    assert meta["title"] == "Test Stream"
+    assert meta["status"] == "active"
+    assert body.strip() == ""
+
+
+def test_parse_frontmatter_none():
+    meta, body = parse_frontmatter("No frontmatter here.\nJust text.")
+    assert meta == {}
+    assert "No frontmatter here." in body
+
+
+def test_parse_frontmatter_no_close():
+    text = "---\nid: oops\nNo closing delimiter"
+    meta, body = parse_frontmatter(text)
+    assert meta == {}
+    assert body == text
+
+
+def test_write_frontmatter_roundtrip():
+    meta, _ = parse_frontmatter(_SAMPLE_FRONTMATTER)
+    rebuilt = write_frontmatter(meta, "")
+    meta2, _ = parse_frontmatter(rebuilt)
+    for key in ("id", "title", "status", "size"):
+        assert str(meta[key]) == str(meta2[key])
+    assert meta2["tags"] == meta["tags"]
+
+
+# ---------------------------------------------------------------------------
+# Thread
+# ---------------------------------------------------------------------------
+
+
+def test_parse_thread_entries():
+    entries = parse_thread(_SAMPLE_BODY)
+    assert len(entries) == 2
+    assert entries[0].date == "2026-03-28"
+    assert "Did some work today." in entries[0].body
+    # Multi-line body preserved
+    assert "Multi-line body here." in entries[0].body
+    assert entries[1].date == "2026-03-27"
+
+
+def test_parse_thread_empty():
+    body = "## Decisions\n- Something\n"
+    assert parse_thread(body) == []
+
+
+# ---------------------------------------------------------------------------
+# Bullets
+# ---------------------------------------------------------------------------
+
+
+def test_parse_decisions():
+    items = parse_decisions(_SAMPLE_BODY)
+    assert items == ["Use Python 3.11+", "Adopt face for CLI"]
+
+
+def test_parse_plans():
+    plans = parse_plans(_SAMPLE_BODY)
+    assert len(plans) == 1
+    assert plans[0] == PlanRef(repo="my-repo", path="migrate.md", status="active", title='', date='')
+
+
+def test_parse_branches():
+    branches = parse_branches(_SAMPLE_BODY)
+    assert len(branches) == 1
+    assert branches[0] == BranchRef(repo="my-repo", branch="feature/ws-cli", ahead=3)
+
+
+def test_parse_next_actions():
+    items = parse_next_actions(_SAMPLE_BODY)
+    assert items == ["Write tests", "Ship v1"]
+
+
+# ---------------------------------------------------------------------------
+# Sections
+# ---------------------------------------------------------------------------
+
+
+def test_get_section_present():
+    section = get_section(_SAMPLE_BODY, "Decisions")
+    assert section is not None
+    assert "Use Python 3.11+" in section
+
+
+def test_get_section_absent():
+    assert get_section(_SAMPLE_BODY, "Nonexistent") is None
+
+
+def test_set_section_replace():
+    body = "## Alpha\nold content\n\n## Beta\nkeep\n"
+    updated = set_section(body, "Alpha", "new content")
+    assert "new content" in updated
+    assert "old content" not in updated
+    # Beta untouched
+    assert "keep" in updated
+
+
+def test_set_section_append():
+    body = "## Alpha\ncontent\n"
+    updated = set_section(body, "Gamma", "gamma stuff")
+    assert "## Gamma" in updated
+    assert "gamma stuff" in updated
+    # Original section preserved
+    assert "## Alpha" in updated
+
+
+# ---------------------------------------------------------------------------
+# Thread mutation
+# ---------------------------------------------------------------------------
+
+
+def test_append_thread_entry():
+    body = "## Thread\n### 2026-03-27\nOld entry.\n"
+    updated = append_thread_entry(body, "2026-03-28", "New entry.")
+    # New entry at top
+    thread_pos = updated.index("## Thread\n")
+    new_pos = updated.index("### 2026-03-28")
+    old_pos = updated.index("### 2026-03-27")
+    assert new_pos < old_pos
+    assert "New entry." in updated
+
+
+# ---------------------------------------------------------------------------
+# Full file round-trip
+# ---------------------------------------------------------------------------
+
+
+def test_load_workstream(tmp_path: Path):
+    content = _SAMPLE_FRONTMATTER + _SAMPLE_BODY
+    fp = tmp_path / "test.md"
+    fp.write_text(content, encoding="utf-8")
+
+    ws = load_workstream(fp)
+    assert ws.id == "2026-03-28-abc1234567"
+    assert ws.title == "Test Stream"
+    assert ws.status == "active"
+    # PyYAML may parse '2026-01-15' as datetime.date; load_workstream casts to str
+    assert ws.created == "2026-01-15"
+    assert ws.updated == "2026-03-28"
+    assert ws.tags == ["infra", "backend"]
+    assert ws.repos == ["my-repo"]
+    assert len(ws.thread) == 2
+    assert len(ws.decisions) == 2
+    assert len(ws.plans) == 1
+    assert ws.plans[0].repo == "my-repo"
+    assert len(ws.branches) == 1
+    assert len(ws.next_actions) == 2
+    assert ws.source_path == fp
+
+
+def test_save_and_reload(tmp_path: Path):
+    ws = Workstream(
+        id="2026-03-28-0000000000",
+        title="Round Trip",
+        status="active",
+        size="week",
+        tags=["cli"],
+        repos=["core"],
+        created="2026-01-01",
+        updated="2026-03-28",
+        thread=[ThreadEntry(date="2026-03-28", body="Entry body.")],
+        decisions=["Decision A"],
+        plans=[PlanRef(repo="core", path="plan.md", status="draft", title='', date='')],
+        branches=[BranchRef(repo="core", branch="feat/x", ahead=5)],
+        next_actions=["Do something"],
+    )
+    fp = tmp_path / ws.filename
+    save_workstream(ws, fp)
+
+    loaded = load_workstream(fp)
+    assert loaded.id == ws.id
+    assert loaded.title == ws.title
+    assert loaded.status == ws.status
+    assert loaded.size == ws.size
+    assert loaded.tags == ws.tags
+    assert loaded.repos == ws.repos
+    assert loaded.created == ws.created
+    assert loaded.updated == ws.updated
+    assert len(loaded.thread) == 1
+    assert loaded.thread[0].date == "2026-03-28"
+    assert "Entry body." in loaded.thread[0].body
+    assert loaded.decisions == ["Decision A"]
+    assert len(loaded.plans) == 1
+    assert loaded.plans[0].repo == "core"
+    assert len(loaded.branches) == 1
+    assert loaded.branches[0].ahead == 5
+    assert loaded.next_actions == ["Do something"]
+
+
+def test_render_body():
+    ws = Workstream(
+        id="x",
+        title="Render Test",
+        tags=["t1"],
+        thread=[ThreadEntry(date="2026-03-28", body="Note.")],
+        next_actions=["Act"],
+    )
+    body = render_body(ws)
+    assert body.startswith("# Render Test\n")
+    assert "#t1" in body
+    assert "## Thread" in body
+    assert "### 2026-03-28" in body
+    assert "Note." in body
+    assert "## Next" in body
+    assert "- Act" in body
+    # Empty optional sections omitted
+    assert "## Decisions" not in body
+    assert "## Plans" not in body
+    assert "## Branches" not in body
+
+
+
+# ---------------------------------------------------------------------------
+# Thoughts section
+# ---------------------------------------------------------------------------
+
+
+def test_parse_thoughts_basic():
+    body = '## Thoughts\n- [2026-03-28] Should add confetti\n- [2026-03-27] Rethink API versioning\n'
+    thoughts = parse_thoughts(body)
+    assert len(thoughts) == 2
+    assert thoughts[0].date == '2026-03-28'
+    assert thoughts[0].text == 'Should add confetti'
+    assert thoughts[0].snooze_until == ''
+    assert thoughts[0].snooze_count == 0
+    assert thoughts[1].date == '2026-03-27'
+    assert thoughts[1].text == 'Rethink API versioning'
+
+
+def test_parse_thoughts_with_snooze():
+    body = '## Thoughts\n- [2026-03-28] Some idea (snooze: 2026-04-04, count: 2)\n'
+    thoughts = parse_thoughts(body)
+    assert len(thoughts) == 1
+    assert thoughts[0].text == 'Some idea'
+    assert thoughts[0].snooze_until == '2026-04-04'
+    assert thoughts[0].snooze_count == 2
+
+
+def test_parse_thoughts_empty():
+    body = '## Thread\n### 2026-03-28\nSome work.\n'
+    assert parse_thoughts(body) == []
+
+
+def test_append_thought_creates_section():
+    body = '## Thread\nSome content\n'
+    t = ThoughtEntry(date='2026-03-28', text='New idea')
+    updated = append_thought(body, t)
+    assert '## Thoughts' in updated
+    assert '- [2026-03-28] New idea' in updated
+    # Original content preserved
+    assert '## Thread' in updated
+
+
+def test_append_thought_to_existing():
+    body = '## Thoughts\n- [2026-03-27] Old idea\n'
+    t = ThoughtEntry(date='2026-03-28', text='New idea')
+    updated = append_thought(body, t)
+    assert '- [2026-03-27] Old idea' in updated
+    assert '- [2026-03-28] New idea' in updated
+
+
+def test_render_body_with_thoughts():
+    ws = Workstream(
+        id='x',
+        title='Test',
+        thoughts=[ThoughtEntry(date='2026-03-28', text='Cool idea')],
+        next_actions=['Do something'],
+    )
+    body = render_body(ws)
+    assert '## Thoughts' in body
+    assert '- [2026-03-28] Cool idea' in body
+
+
+def test_render_body_omits_empty_thoughts():
+    ws = Workstream(id='x', title='Test', next_actions=['Do something'])
+    body = render_body(ws)
+    assert '## Thoughts' not in body
+
+
+# ---------------------------------------------------------------------------
+# Hierarchy fields round-trip
+# ---------------------------------------------------------------------------
+
+
+def test_load_workstream_with_parent(tmp_path: Path):
+    content = '''---
+id: '2026-03-28-abc1234567'
+title: Child Stream
+status: active
+parent: '2026-01-01-parent123'
+snooze_until: '2026-04-15'
+snooze_count: 2
+---
+
+# Child Stream
+
+## Thread
+### 2026-03-28
+Some work.
+
+## Next
+- Do something
+'''
+    fp = tmp_path / 'test.md'
+    fp.write_text(content, encoding='utf-8')
+    ws = load_workstream(fp)
+    assert ws.parent == '2026-01-01-parent123'
+    assert ws.snooze_until == '2026-04-15'
+    assert ws.snooze_count == 2
+
+
+def test_save_and_reload_with_parent_and_thoughts(tmp_path: Path):
+    ws = Workstream(
+        id='2026-03-28-0000000000',
+        title='Round Trip',
+        status='active',
+        parent='2026-01-01-parent123',
+        snooze_until='2026-05-01',
+        snooze_count=1,
+        thread=[ThreadEntry(date='2026-03-28', body='Entry body.')],
+        thoughts=[
+            ThoughtEntry(date='2026-03-28', text='A thought'),
+            ThoughtEntry(date='2026-03-27', text='Snoozed thought', snooze_until='2026-04-10', snooze_count=3),
+        ],
+        next_actions=['Do something'],
+    )
+    fp = tmp_path / ws.filename
+    save_workstream(ws, fp)
+
+    loaded = load_workstream(fp)
+    assert loaded.parent == '2026-01-01-parent123'
+    assert loaded.snooze_until == '2026-05-01'
+    assert loaded.snooze_count == 1
+    assert len(loaded.thoughts) == 2
+    assert loaded.thoughts[0].date == '2026-03-28'
+    assert loaded.thoughts[0].text == 'A thought'
+    assert loaded.thoughts[0].snooze_until == ''
+    assert loaded.thoughts[1].text == 'Snoozed thought'
+    assert loaded.thoughts[1].snooze_until == '2026-04-10'
+    assert loaded.thoughts[1].snooze_count == 3
+
+
+# ---------------------------------------------------------------------------
+# Ideas section
+# ---------------------------------------------------------------------------
+
+
+def test_parse_ideas_basic():
+    body = '## Ideas\n- [2026-03-28] Build a rate alert system\n- [2026-03-27] Add a leaderboard\n'
+    ideas = parse_ideas(body)
+    assert len(ideas) == 2
+    assert ideas[0].date == '2026-03-28'
+    assert ideas[0].text == 'Build a rate alert system'
+    assert ideas[0].snooze_until == ''
+
+
+def test_parse_ideas_with_snooze():
+    body = '## Ideas\n- [2026-03-28] Some idea (snooze: 2026-04-04, count: 1)\n'
+    ideas = parse_ideas(body)
+    assert len(ideas) == 1
+    assert ideas[0].snooze_until == '2026-04-04'
+    assert ideas[0].snooze_count == 1
+
+
+def test_parse_ideas_empty():
+    body = '## Thread\n### 2026-03-28\nSome work.\n'
+    assert parse_ideas(body) == []
+
+
+def test_append_idea_creates_section():
+    body = '## Thread\nSome content\n'
+    idea = IdeaEntry(date='2026-03-28', text='New idea')
+    updated = append_idea(body, idea)
+    assert '## Ideas' in updated
+    assert '- [2026-03-28] New idea' in updated
+    assert '## Thread' in updated
+
+
+def test_append_idea_to_existing():
+    body = '## Ideas\n- [2026-03-27] Old idea\n'
+    idea = IdeaEntry(date='2026-03-28', text='New idea')
+    updated = append_idea(body, idea)
+    assert '- [2026-03-27] Old idea' in updated
+    assert '- [2026-03-28] New idea' in updated
+
+
+# ---------------------------------------------------------------------------
+# Log section
+# ---------------------------------------------------------------------------
+
+
+def test_parse_log_basic():
+    body = '## Log\n- [2026-03-28] created (active, day)\n- [2026-03-29] snoozed until 2026-04-07: Waiting on review\n'
+    log = parse_log(body)
+    assert len(log) == 2
+    assert log[0].date == '2026-03-28'
+    assert log[0].event == 'created'
+    assert log[0].detail == '(active, day)'
+    assert log[1].event == 'snoozed'
+    assert 'Waiting on review' in log[1].detail
+
+
+def test_parse_log_empty():
+    body = '## Thread\nSome work.\n'
+    assert parse_log(body) == []
+
+
+def test_append_log_entry_creates_section():
+    body = '## Thread\nSome content\n'
+    entry = LogEntry(date='2026-03-28', event='created', detail='(active, day)')
+    updated = append_log_entry(body, entry)
+    assert '## Log' in updated
+    assert '- [2026-03-28] created (active, day)' in updated
+
+
+def test_append_log_entry_to_existing():
+    body = '## Log\n- [2026-03-28] created (active, day)\n'
+    entry = LogEntry(date='2026-03-29', event='snoozed', detail='until 2026-04-07: Blocked')
+    updated = append_log_entry(body, entry)
+    assert '- [2026-03-28] created' in updated
+    assert '- [2026-03-29] snoozed until 2026-04-07: Blocked' in updated
+
+
+# ---------------------------------------------------------------------------
+# Render body with ideas and log
+# ---------------------------------------------------------------------------
+
+
+def test_render_body_with_ideas_and_log():
+    ws = Workstream(
+        id='x',
+        title='Test',
+        ideas=[IdeaEntry(date='2026-03-28', text='Cool idea')],
+        log=[LogEntry(date='2026-03-28', event='created', detail='(active, day)')],
+        next_actions=['Do something'],
+    )
+    body = render_body(ws)
+    assert '## Ideas' in body
+    assert '- [2026-03-28] Cool idea' in body
+    assert '## Log' in body
+    assert '- [2026-03-28] created (active, day)' in body
+    # Log should appear after Next
+    next_pos = body.index('## Next')
+    log_pos = body.index('## Log')
+    assert log_pos > next_pos
+
+
+# ---------------------------------------------------------------------------
+# Plans 30-day terminal window
+# ---------------------------------------------------------------------------
+
+
+def test_render_body_plans_30day_window():
+    """All plans are rendered regardless of age — no truncation."""
+    from datetime import date, timedelta
+
+    today = date.today()
+    recent = (today - timedelta(days=10)).isoformat()
+    old = (today - timedelta(days=60)).isoformat()
+    ancient = (today - timedelta(days=120)).isoformat()
+
+    ws = Workstream(
+        id='x', title='Test',
+        plans=[
+            PlanRef(repo='r', path='active.md', status='active', title='Active', date=today.isoformat()),
+            PlanRef(repo='r', path='recent-impl.md', status='implemented', title='Recent', date=recent),
+            PlanRef(repo='r', path='old-impl.md', status='implemented', title='Old Impl', date=old),
+            PlanRef(repo='r', path='old-obs.md', status='obsolete', title='Old Obs', date=ancient),
+            PlanRef(repo='r', path='tabled.md', status='tabled', title='Tabled', date=old),
+        ],
+    )
+    body = render_body(ws)
+
+    # All plans visible — no truncation
+    assert 'active.md' in body
+    assert 'tabled.md' in body
+    assert 'recent-impl.md' in body
+    assert 'old-impl.md' in body
+    assert 'old-obs.md' in body
+    # No summary comment
+    assert 'older plans' not in body
+
+
+def test_render_body_plans_no_old_terminal():
+    """No summary comment when all terminal plans are recent."""
+    from datetime import date, timedelta
+
+    recent = (date.today() - timedelta(days=5)).isoformat()
+    ws = Workstream(
+        id='x', title='Test',
+        plans=[
+            PlanRef(repo='r', path='done.md', status='implemented', title='Done', date=recent),
+        ],
+    )
+    body = render_body(ws)
+    assert 'done.md' in body
+    assert 'older plans' not in body
+
+
+def test_plan_roundtrip_plan_type_guidance():
+    """render_body -> parse_plans round-trips plan_type and guidance fields."""
+    ws = Workstream(
+        id='x', title='Test',
+        plans=[
+            PlanRef(repo='r', path='proj.md', status='active', title='Big Project',
+                    date='2026-03-01', signal='', plan_type='project', guidance='new-peer'),
+            PlanRef(repo='r', path='tac.md', status='draft', title='Quick Fix',
+                    date='2026-03-02', plan_type='tactical', guidance='keep-current'),
+            PlanRef(repo='r', path='plain.md', status='active', title='Plain',
+                    date='2026-03-03'),
+        ],
+    )
+    body = render_body(ws)
+
+    # Verify serialized format
+    assert 'type:project' in body
+    assert 'guidance:new-peer' in body
+    assert 'type:tactical' in body
+    assert 'guidance:keep-current' in body
+
+    # Round-trip
+    plans = parse_plans(body)
+    assert len(plans) == 3
+
+    by_path = {p.path: p for p in plans}
+    assert by_path['proj.md'].plan_type == 'project'
+    assert by_path['proj.md'].guidance == 'new-peer'
+    assert by_path['tac.md'].plan_type == 'tactical'
+    assert by_path['tac.md'].guidance == 'keep-current'
+    assert by_path['plain.md'].plan_type == ''
+    assert by_path['plain.md'].guidance == ''