@pennyfarthing/core 10.0.2 → 10.0.5

package/pennyfarthing_scripts/sprint/loader.py

@@ -0,0 +1,237 @@
+"""
+Sprint YAML parsing utilities for Pennyfarthing scripts.
+
+Provides access to sprint/current-sprint.yaml data.
+Supports sharded per-epic format (epic-{ref}.yaml shard files).
+"""
+
+from pathlib import Path
+from typing import Any
+
+from pennyfarthing_scripts.common.config import get_project_root, load_yaml_config
+
+
+def _merge_epic_shards(data: dict[str, Any], sprint_dir: Path) -> dict[str, Any]:
+    """Merge sharded epic files into the sprint data structure.
+
+    When the epics list contains strings (shard references like "MSSCI-14298"
+    or "epic-40"), load each epic-{ref}.yaml and replace the string with
+    the full epic dict.
+
+    Args:
+        data: Sprint data with possible string refs in epics
+        sprint_dir: Directory containing the shard files
+
+    Returns:
+        Sprint data with full epic dicts
+    """
+    epics = data.get("epics", [])
+    if not epics or not isinstance(epics[0], str):
+        return data
+
+    merged_epics = []
+    for ref in epics:
+        if not isinstance(ref, str):
+            merged_epics.append(ref)
+            continue
+
+        epic_file = sprint_dir / f"epic-{ref}.yaml"
+        if epic_file.exists():
+            epic_data = load_yaml_config(epic_file)
+            if epic_data is not None:
+                merged_epics.append(epic_data)
+
+    data["epics"] = merged_epics
+    return data
+
+
+def load_sprint(project_root: Path | None = None) -> dict[str, Any] | None:
+    """Load sprint data from project root.
+
+    Supports both monolithic and sharded epic formats. When epics are
+    string references, the corresponding epic-{ref}.yaml files are
+    loaded and merged transparently.
+
+    Args:
+        project_root: Project root path (defaults to auto-detect)
+
+    Returns:
+        Sprint data as dict, or None if not found
+    """
+    root = project_root or get_project_root()
+    sprint_dir = root / "sprint"
+    sprint_path = sprint_dir / "current-sprint.yaml"
+    data = load_yaml_config(sprint_path)
+    if data is None:
+        return None
+
+    return _merge_epic_shards(data, sprint_dir)
+
+
+def find_epic(sprint_data: dict[str, Any], epic_num: str) -> dict[str, Any] | None:
+    """Find epic in sprint data (handles various ID formats).
+
+    Args:
+        sprint_data: Sprint YAML data
+        epic_num: Epic number (e.g., "63", "epic-63", or "63")
+
+    Returns:
+        Epic dict if found, None otherwise
+    """
+    if not sprint_data or "epics" not in sprint_data:
+        return None
+
+    # Normalize the epic number
+    epic_num_clean = epic_num.replace("epic-", "")
+
+    for epic in sprint_data["epics"]:
+        epic_id = str(epic.get("id", ""))
+        # Match "63", "epic-63", or just the number
+        if epic_id == epic_num or epic_id == f"epic-{epic_num}" or epic_id == epic_num_clean:
+            return epic
+        # Also try without prefix
+        if epic_id.replace("epic-", "") == epic_num_clean:
+            return epic
+
+    return None
+
+
+# Alias for backwards compatibility
+load_current_sprint = load_sprint
+
+
+def get_sprint_info() -> dict[str, Any]:
+    """Get sprint metadata (number, dates, status, etc).
+
+    Returns:
+        Sprint info dict with number, status, goal, etc.
+    """
+    data = load_sprint()
+    if data and "sprint" in data:
+        return data["sprint"]
+    return {}
+
+
+def get_all_stories() -> list[dict[str, Any]]:
+    """Get all stories from all epics.
+
+    Returns:
+        Flat list of all story dicts
+    """
+    data = load_sprint()
+    if not data or "epics" not in data:
+        return []
+
+    stories = []
+    for epic in data["epics"]:
+        if "stories" in epic:
+            stories.extend(epic["stories"])
+    return stories
+
+
+def get_story_by_id(story_id: str) -> dict[str, Any] | None:
+    """Find a story by its ID.
+
+    Args:
+        story_id: The story ID (e.g., "63-4" or "MSSCI-12398")
+
+    Returns:
+        Story dict if found, None otherwise
+    """
+    for story in get_all_stories():
+        if story.get("id") == story_id:
+            return story
+        # Also check jira field
+        if story.get("jira") == story_id:
+            return story
+    return None
+
+
+def get_stories_by_status(status: str) -> list[dict[str, Any]]:
+    """Get all stories with a given status.
+
+    Args:
+        status: Status to filter by (e.g., "backlog", "in_progress", "done")
+
+    Returns:
+        List of stories matching the status
+    """
+    return [s for s in get_all_stories() if s.get("status") == status]
+
+
+def get_epic_by_id(epic_id: str) -> dict[str, Any] | None:
+    """Find an epic by its ID.
+
+    Args:
+        epic_id: The epic ID
+
+    Returns:
+        Epic dict if found, None otherwise
+    """
+    data = load_sprint()
+    if not data or "epics" not in data:
+        return None
+
+    for epic in data["epics"]:
+        if epic.get("id") == epic_id:
+            return epic
+    return None
+
+
+def find_story(epic: dict[str, Any] | None, story_id: str) -> dict[str, Any] | None:
+    """Find a story within an epic by its ID.
+
+    Args:
+        epic: Epic dict containing stories
+        story_id: The story ID (e.g., "63-7")
+
+    Returns:
+        Story dict if found, None otherwise
+    """
+    if not epic or "stories" not in epic:
+        return None
+
+    for story in epic["stories"]:
+        if story.get("id") == story_id:
+            return story
+
+    return None
+
+
+def get_story_field(
+    sprint_data: dict[str, Any], story_id: str, field_name: str
+) -> Any | None:
+    """Get a specific field from a story in sprint data.
+
+    Extracts the epic number from the story ID (e.g., "63-7" -> epic 63)
+    and looks up the story within that epic.
+
+    Args:
+        sprint_data: Sprint YAML data
+        story_id: The story ID (e.g., "63-7")
+        field_name: The field to extract (e.g., "status", "points", "workflow")
+
+    Returns:
+        Field value if found, None otherwise
+    """
+    if not sprint_data or not story_id:
+        return None
+
+    # Extract epic number from story ID (e.g., "63-7" -> "63")
+    parts = story_id.split("-")
+    if len(parts) < 2:
+        return None
+
+    epic_num = parts[0]
+
+    # Find the epic
+    epic = find_epic(sprint_data, epic_num)
+    if not epic:
+        return None
+
+    # Find the story within the epic
+    story = find_story(epic, story_id)
+    if not story:
+        return None
+
+    return story.get(field_name)

package/pennyfarthing_scripts/sprint/status.py

@@ -0,0 +1,122 @@
+"""
+Sprint status operations.
+
+Provides functions for getting and displaying sprint status.
+"""
+
+from typing import Any
+
+from pennyfarthing_scripts.sprint.loader import get_all_stories, get_sprint_info, load_sprint
+
+
+def get_sprint_status(filter_status: str | None = None) -> dict[str, Any]:
+    """Get sprint status with story counts.
+
+    Args:
+        filter_status: Optional status to filter by
+
+    Returns:
+        Dict with sprint status information
+    """
+    sprint_info = get_sprint_info()
+    stories = get_all_stories()
+
+    if not stories:
+        return {}
+
+    # Count by status
+    status_counts: dict[str, int] = {}
+    total_points = 0
+    completed_points = 0
+
+    for story in stories:
+        status = story.get("status", "backlog")
+        points = story.get("points", 0) or 0
+
+        status_counts[status] = status_counts.get(status, 0) + 1
+        total_points += points
+
+        if status in ("done", "completed"):
+            completed_points += points
+
+    return {
+        "sprint": sprint_info,
+        "total_stories": len(stories),
+        "by_status": status_counts,
+        "backlog": status_counts.get("backlog", 0),
+        "in_progress": status_counts.get("in_progress", 0),
+        "review": status_counts.get("review", 0),
+        "completed": status_counts.get("done", 0) + status_counts.get("completed", 0),
+        "total_points": total_points,
+        "completed_points": completed_points,
+    }
+
+
+def format_status(status: dict[str, Any]) -> str:
+    """Format sprint status as human-readable string.
+
+    Args:
+        status: Status dict from get_sprint_status
+
+    Returns:
+        Formatted status string
+    """
+    if not status:
+        return "No sprint data available"
+
+    lines = []
+
+    # Sprint header
+    sprint = status.get("sprint", {})
+    if sprint:
+        lines.append(f"Sprint: {sprint.get('name', 'Unknown')}")
+        lines.append(f"Status: {sprint.get('status', 'unknown')}")
+        if sprint.get("goal"):
+            lines.append(f"Goal: {sprint['goal']}")
+        lines.append("")
+
+    # Story counts
+    lines.append(f"Total Stories: {status.get('total_stories', 0)}")
+    lines.append(f"  Backlog: {status.get('backlog', 0)}")
+    lines.append(f"  In Progress: {status.get('in_progress', 0)}")
+    lines.append(f"  In Review: {status.get('review', 0)}")
+    lines.append(f"  Completed: {status.get('completed', 0)}")
+    lines.append("")
+
+    # Points
+    lines.append(f"Points: {status.get('completed_points', 0)}/{status.get('total_points', 0)}")
+
+    return "\n".join(lines)
+
+
+def main(args: list[str] | None = None) -> int:
+    """CLI entry point for sprint status.
+
+    Args:
+        args: Command line arguments
+
+    Returns:
+        Exit code
+    """
+    import argparse
+    import sys
+
+    parser = argparse.ArgumentParser(description="Show sprint status")
+    parser.add_argument(
+        "filter",
+        nargs="?",
+        choices=["backlog", "todo", "in-progress", "review", "done"],
+        help="Filter by status",
+    )
+
+    parsed = parser.parse_args(args)
+
+    status = get_sprint_status(parsed.filter)
+    print(format_status(status))
+
+    return 0
+
+
+if __name__ == "__main__":
+    import sys
+    sys.exit(main())

package/pennyfarthing_scripts/sprint/story_add.py

@@ -0,0 +1,187 @@
+"""Sprint story add command.
+
+Story: MSSCI-14256 - Sprint story add command
+
+This module provides:
+- generate_story_id(sprint_data, epic) -> str
+- add_story(sprint_path, epic_id, title, points, ...) -> dict
+- story_add_command (Click command for CLI registration)
+"""
+
+from pathlib import Path
+from typing import Any
+
+import click
+from ruamel.yaml.comments import CommentedMap
+
+from pennyfarthing_scripts.sprint.loader import find_epic
+from pennyfarthing_scripts.sprint.validator import validate_full_sprint
+from pennyfarthing_scripts.sprint.yaml_io import (
+    STORY_KEY_ORDER,
+    read_sprint,
+    write_sprint,
+)
+
+
+def _extract_epic_num(epic: Any) -> str:
+    """Extract the numeric part from an epic ID like 'epic-76' -> '76'."""
+    epic_id = str(epic.get("id", ""))
+    return epic_id.replace("epic-", "")
+
+
+def generate_story_id(sprint_data: Any, epic: Any) -> str:
+    """Generate the next story ID for an epic.
+
+    Args:
+        sprint_data: Full sprint YAML data
+        epic: The target epic dict/CommentedMap
+
+    Returns:
+        Next story ID string (e.g., "76-3")
+    """
+    epic_num = _extract_epic_num(epic)
+    stories = epic.get("stories", [])
+
+    max_seq = 0
+    for story in stories:
+        story_id = str(story.get("id", ""))
+        parts = story_id.split("-")
+        if len(parts) >= 2:
+            try:
+                seq = int(parts[-1])
+                if seq > max_seq:
+                    max_seq = seq
+            except ValueError:
+                pass
+
+    return f"{epic_num}-{max_seq + 1}"
+
+
+def add_story(
+    sprint_path: Path,
+    epic_id: str,
+    title: str,
+    points: int,
+    *,
+    story_type: str | None = None,
+    priority: str = "P1",
+    workflow: str = "tdd",
+    jira: str | None = None,
+) -> dict[str, Any]:
+    """Add a new story to an epic in the sprint YAML.
+
+    Args:
+        sprint_path: Path to sprint YAML file
+        epic_id: Epic ID to add the story to
+        title: Story title
+        points: Story points
+        story_type: Optional story type (feature, bug, chore, refactor)
+        priority: Priority (default: P1)
+        workflow: Workflow (default: tdd)
+        jira: Optional Jira key
+
+    Returns:
+        Dict with success status and story_id or error
+    """
+    data = read_sprint(sprint_path)
+
+    epic = find_epic(data, epic_id)
+    if epic is None:
+        available = []
+        for e in data.get("epics", []):
+            available.append(str(e.get("id", "")))
+        return {
+            "success": False,
+            "error": f"Epic '{epic_id}' not found. Available epics: {', '.join(available)}",
+        }
+
+    story_id = generate_story_id(data, epic)
+
+    # Build story as CommentedMap with canonical key ordering
+    story = CommentedMap()
+    fields: dict[str, Any] = {
+        "id": story_id,
+        "title": title,
+        "points": points,
+        "priority": priority,
+        "status": "backlog",
+        "workflow": workflow,
+    }
+    if jira is not None:
+        fields["jira"] = jira
+    if story_type is not None:
+        fields["type"] = story_type
+
+    # Insert keys in STORY_KEY_ORDER, then any extras
+    for key in STORY_KEY_ORDER:
+        if key in fields:
+            story[key] = fields[key]
+    for key in fields:
+        if key not in STORY_KEY_ORDER:
+            story[key] = fields[key]
+
+    # Append to epic's stories list
+    if "stories" not in epic:
+        from ruamel.yaml.comments import CommentedSeq
+        epic["stories"] = CommentedSeq()
+    epic["stories"].append(story)
+
+    # Validate before writing
+    result = validate_full_sprint(data)
+    if not result.valid:
+        # Remove the story we just added to avoid corrupting data
+        epic["stories"].pop()
+        return {
+            "success": False,
+            "error": f"Validation failed after insertion: {result.errors}",
+        }
+
+    write_sprint(sprint_path, data)
+
+    return {
+        "success": True,
+        "story_id": story_id,
+    }
+
+
+@click.command("add")
+@click.argument("epic_id", type=str)
+@click.argument("title", type=str)
+@click.argument("points", type=int)
+@click.option("--type", "story_type", type=click.Choice(["feature", "bug", "chore", "refactor"]), default="feature")
+@click.option("--priority", type=click.Choice(["P0", "P1", "P2", "P3"]), default="P1")
+@click.option("--workflow", type=click.Choice(["tdd", "trivial", "bdd"]), default="tdd")
+@click.option("--jira", "jira_id", type=str, default=None)
+@click.option("--sprint-file", type=click.Path(), default=None, help="Path to sprint YAML file")
+def story_add_command(
+    epic_id: str,
+    title: str,
+    points: int,
+    story_type: str,
+    priority: str,
+    workflow: str,
+    jira_id: str | None,
+    sprint_file: str | None,
+) -> None:
+    """Add a new story to an epic."""
+    if sprint_file is None:
+        from pennyfarthing_scripts.common.config import get_project_root
+        path = get_project_root() / "sprint" / "current-sprint.yaml"
+    else:
+        path = Path(sprint_file)
+
+    result = add_story(
+        sprint_path=path,
+        epic_id=epic_id,
+        title=title,
+        points=points,
+        story_type=story_type if story_type != "feature" else None,
+        priority=priority,
+        workflow=workflow,
+        jira=jira_id,
+    )
+
+    if result["success"]:
+        click.echo(f"Added story {result['story_id']}: {title} [{points}pts]")
+    else:
+        raise click.ClickException(result["error"])