moai-adk 0.35.1__py3-none-any.whl

moai_adk/core/spec_status_manager.py

@@ -0,0 +1,478 @@
+"""SPEC Status Manager
+
+Automated management of SPEC status transitions from 'draft' to 'completed'
+based on implementation completion detection and validation criteria.
+"""
+
+import logging
+import re
+from datetime import datetime
+from pathlib import Path
+from typing import Any, Dict, List, Set
+
+import yaml  # type: ignore
+
+logger = logging.getLogger(__name__)
+
+
+class SpecStatusManager:
+    """Manages SPEC status detection and updates based on implementation completion"""
+
+    def __init__(self, project_root: Path):
+        """Initialize the SPEC status manager
+
+        Args:
+            project_root: Root directory of the MoAI project
+        """
+        self.project_root = Path(project_root)
+        self.specs_dir = self.project_root / ".moai" / "specs"
+        self.src_dir = self.project_root / "src"
+        self.tests_dir = self.project_root / "tests"
+        self.docs_dir = self.project_root / "docs"
+
+        # Validation criteria (configurable)
+        self.validation_criteria = {
+            "min_code_coverage": 0.85,  # 85% minimum coverage
+            "require_acceptance_criteria": True,
+            "min_implementation_age_days": 0,  # Days since last implementation
+        }
+
+    def detect_draft_specs(self) -> Set[str]:
+        """Detect all SPEC files with 'draft' status
+
+        Returns:
+            Set of SPEC IDs that have draft status
+        """
+        draft_specs: Set[str] = set()
+
+        if not self.specs_dir.exists():
+            logger.warning(f"SPEC directory not found: {self.specs_dir}")
+            return draft_specs
+
+        for spec_dir in self.specs_dir.iterdir():
+            if spec_dir.is_dir():
+                spec_file = spec_dir / "spec.md"
+                if spec_file.exists():
+                    try:
+                        # Read frontmatter to check status
+                        with open(spec_file, "r", encoding="utf-8") as f:
+                            content = f.read()
+
+                        frontmatter = None
+
+                        # Handle JSON-like meta (common in older specs)
+                        meta_match = re.search(r"<%?\s*---\s*\n(.*?)\n---\s*%?>", content, re.DOTALL)
+                        if meta_match:
+                            try:
+                                meta_text = meta_match.group(1)
+                                # Replace JSON-style quotes and parse as YAML
+                                meta_text = meta_text.replace('"', "").replace("'", "")
+                                frontmatter = yaml.safe_load("{" + meta_text + "}")
+                            except Exception as e:
+                                logger.debug(f"JSON meta parsing failed for {spec_dir.name}: {e}")
+
+                        # Handle regular YAML frontmatter
+                        elif content.startswith("---"):
+                            end_marker = content.find("---", 3)
+                            if end_marker != -1:
+                                frontmatter_text = content[3:end_marker].strip()
+                                try:
+                                    frontmatter = yaml.safe_load(frontmatter_text)
+                                except yaml.YAMLError as e:
+                                    logger.warning(f"YAML parsing error for {spec_dir.name}: {e}")
+                                    # Try to fix common issues (like @ in author field)
+                                    try:
+                                        # Replace problematic @author entries
+                                        fixed_text = frontmatter_text
+                                        if "author: @" in fixed_text:
+                                            fixed_text = re.sub(
+                                                r"author:\s*@(\w+)",
+                                                r'author: "\1"',
+                                                fixed_text,
+                                            )
+                                        frontmatter = yaml.safe_load(fixed_text)
+                                    except yaml.YAMLError:
+                                        logger.error(f"Could not parse YAML for {spec_dir.name} even after fixes")
+                                        continue
+
+                        if frontmatter and frontmatter.get("status") == "draft":
+                            spec_id = spec_dir.name
+                            draft_specs.add(spec_id)
+                            logger.debug(f"Found draft SPEC: {spec_id}")
+
+                    except Exception as e:
+                        logger.error(f"Error reading SPEC {spec_dir.name}: {e}")
+
+        logger.info(f"Found {len(draft_specs)} draft SPECs")
+        return draft_specs
+
+    def is_spec_implementation_completed(self, spec_id: str) -> bool:
+        """Check if a SPEC's implementation is complete
+
+        Args:
+            spec_id: The SPEC identifier (e.g., "SPEC-001")
+
+        Returns:
+            True if implementation is complete, False otherwise
+        """
+        spec_dir = self.specs_dir / spec_id
+        spec_file = spec_dir / "spec.md"
+
+        if not spec_file.exists():
+            logger.warning(f"SPEC file not found: {spec_file}")
+            return False
+
+        try:
+            # Check basic implementation status
+            spec_dir = spec_file.parent
+
+            # Check for implementation files
+            src_files = list(spec_dir.rglob("*.py")) if (spec_dir.parent.parent / "src").exists() else []
+
+            # Check for test files
+            test_dir = spec_dir.parent.parent / "tests"
+            test_files = list(test_dir.rglob(f"test_*{spec_id.lower()}*.py")) if test_dir.exists() else []
+
+            # Simple completion criteria
+            has_code = len(src_files) > 0
+            has_tests = len(test_files) > 0
+
+            # Check if SPEC has acceptance criteria
+            with open(spec_file, "r", encoding="utf-8") as f:
+                spec_content = f.read()
+            has_acceptance_criteria = "Acceptance Criteria" in spec_content
+
+            # Overall completion check
+            is_complete = has_code and has_tests and has_acceptance_criteria
+
+            logger.info(f"SPEC {spec_id} implementation status: {'COMPLETE' if is_complete else 'INCOMPLETE'}")
+            return is_complete
+
+        except Exception as e:
+            logger.error(f"Error checking SPEC {spec_id} completion: {e}")
+            return False
+
+    def update_spec_status(self, spec_id: str, new_status: str) -> bool:
+        """Update SPEC status in frontmatter
+
+        Args:
+            spec_id: The SPEC identifier
+            new_status: New status value ('completed', 'draft', etc.)
+
+        Returns:
+            True if update successful, False otherwise
+        """
+        spec_dir = self.specs_dir / spec_id
+        spec_file = spec_dir / "spec.md"
+
+        if not spec_file.exists():
+            logger.error(f"SPEC file not found: {spec_file}")
+            return False
+
+        try:
+            with open(spec_file, "r", encoding="utf-8") as f:
+                content = f.read()
+
+            # Extract and update frontmatter
+            if content.startswith("---"):
+                end_marker = content.find("---", 3)
+                if end_marker != -1:
+                    frontmatter_text = content[3:end_marker].strip()
+                    try:
+                        frontmatter = yaml.safe_load(frontmatter_text) or {}
+                    except yaml.YAMLError as e:
+                        logger.warning(f"YAML parsing error for {spec_id}: {e}")
+                        # Try to fix common issues
+                        try:
+                            fixed_text = frontmatter_text
+                            if "author: @" in fixed_text:
+                                fixed_text = re.sub(r"author:\s*@(\w+)", r'author: "\1"', fixed_text)
+                            frontmatter = yaml.safe_load(fixed_text) or {}
+                        except yaml.YAMLError:
+                            logger.error(f"Could not parse YAML for {spec_id} even after fixes")
+                            return False
+
+                    # Update status
+                    frontmatter["status"] = new_status
+
+                    # Bump version if completing
+                    if new_status == "completed":
+                        frontmatter["version"] = self._bump_version(frontmatter.get("version", "0.1.0"))
+                        frontmatter["updated"] = datetime.now().strftime("%Y-%m-%d")
+
+                    # Reconstruct the file
+                    new_frontmatter = yaml.dump(frontmatter, default_flow_style=False)
+                    new_content = f"---\n{new_frontmatter}---{content[end_marker + 3 :]}"
+
+                    # Write back to file
+                    with open(spec_file, "w", encoding="utf-8") as f:
+                        f.write(new_content)
+
+                    logger.info(f"Updated SPEC {spec_id} status to {new_status}")
+                    return True
+
+        except Exception as e:
+            logger.error(f"Error updating SPEC {spec_id} status: {e}")
+            return False
+
+    def get_completion_validation_criteria(self) -> Dict:
+        """Get the current validation criteria for SPEC completion
+
+        Returns:
+            Dictionary of validation criteria
+        """
+        return self.validation_criteria.copy()
+
+    def validate_spec_for_completion(self, spec_id: str) -> Dict[str, Any]:
+        """Validate if a SPEC is ready for completion
+
+        Args:
+            spec_id: The SPEC identifier
+
+        Returns:
+            Dictionary with validation results:
+            {
+                'is_ready': bool,
+                'criteria_met': Dict[str, bool],
+                'issues': List[str],
+                'recommendations': List[str]
+            }
+        """
+        result: Dict[str, Any] = {
+            "is_ready": False,
+            "criteria_met": {},
+            "issues": [],
+            "recommendations": [],
+        }
+
+        try:
+            spec_dir = self.specs_dir / spec_id
+            spec_file = spec_dir / "spec.md"
+
+            if not spec_file.exists():
+                issues_list = result["issues"]
+                if isinstance(issues_list, list):
+                    issues_list.append(f"SPEC file not found: {spec_file}")
+                return result
+
+            # Check implementation status
+            criteria_checks: Dict[str, bool] = {}
+
+            # Check for code implementation
+            spec_dir = spec_file.parent
+            src_dir = spec_dir.parent.parent / "src"
+            criteria_checks["code_implemented"] = src_dir.exists() and len(list(src_dir.rglob("*.py"))) > 0
+            if not criteria_checks["code_implemented"]:
+                issues_list = result["issues"]
+                if isinstance(issues_list, list):
+                    issues_list.append("No source code files found")
+
+            # Check for test implementation
+            test_dir = spec_dir.parent.parent / "tests"
+            test_files = list(test_dir.rglob("test_*.py")) if test_dir.exists() else []
+            criteria_checks["test_implemented"] = len(test_files) > 0
+            if not criteria_checks["test_implemented"]:
+                issues_list = result["issues"]
+                if isinstance(issues_list, list):
+                    issues_list.append("No test files found")
+
+            # Check for acceptance criteria
+            criteria_checks["tasks_completed"] = self._check_acceptance_criteria(spec_file)
+            if not criteria_checks["tasks_completed"]:
+                issues_list = result["issues"]
+                if isinstance(issues_list, list):
+                    issues_list.append("Missing acceptance criteria section")
+
+            # 4. Acceptance criteria present
+            criteria_checks["has_acceptance_criteria"] = self._check_acceptance_criteria(spec_file)
+            if (
+                not criteria_checks["has_acceptance_criteria"]
+                and self.validation_criteria["require_acceptance_criteria"]
+            ):
+                issues_list = result["issues"]
+                if isinstance(issues_list, list):
+                    issues_list.append("Missing acceptance criteria section")
+
+            # 5. Documentation sync
+            criteria_checks["docs_synced"] = self._check_documentation_sync(spec_id)
+            if not criteria_checks["docs_synced"]:
+                recs_list = result["recommendations"]
+                if isinstance(recs_list, list):
+                    recs_list.append("Consider running /moai:3-sync to update documentation")
+
+            result["criteria_met"] = criteria_checks
+            result["is_ready"] = all(criteria_checks.values())
+
+            # Add recommendations
+            if result["is_ready"]:
+                recs_list = result["recommendations"]
+                if isinstance(recs_list, list):
+                    recs_list.append("SPEC is ready for completion. Consider updating status to 'completed'")
+
+        except Exception as e:
+            logger.error(f"Error validating SPEC {spec_id}: {e}")
+            issues_list = result["issues"]
+            if isinstance(issues_list, list):
+                issues_list.append(f"Validation error: {e}")
+
+        return result
+
+    def batch_update_completed_specs(self) -> Dict[str, List[str]]:
+        """Batch update all draft SPECs that have completed implementations
+
+        Returns:
+            Dictionary with update results:
+            {
+                'updated': List[str],  # Successfully updated SPEC IDs
+                'failed': List[str],   # Failed SPEC IDs with errors
+                'skipped': List[str]   # Incomplete SPEC IDs
+            }
+        """
+        results: Dict[str, List[str]] = {"updated": [], "failed": [], "skipped": []}
+
+        draft_specs = self.detect_draft_specs()
+        logger.info(f"Checking {len(draft_specs)} draft SPECs for completion")
+
+        for spec_id in draft_specs:
+            try:
+                # Validate first
+                validation = self.validate_spec_for_completion(spec_id)
+
+                if validation["is_ready"]:
+                    # Update status
+                    if self.update_spec_status(spec_id, "completed"):
+                        updated_list = results["updated"]
+                        if isinstance(updated_list, list):
+                            updated_list.append(spec_id)
+                        logger.info(f"Updated SPEC {spec_id} to completed")
+                    else:
+                        failed_list = results["failed"]
+                        if isinstance(failed_list, list):
+                            failed_list.append(spec_id)
+                        logger.error(f"Failed to update SPEC {spec_id}")
+                else:
+                    skipped_list = results["skipped"]
+                    if isinstance(skipped_list, list):
+                        skipped_list.append(spec_id)
+                    logger.debug(f"SPEC {spec_id} not ready for completion: {validation['issues']}")
+
+            except Exception as e:
+                failed_list = results["failed"]
+                if isinstance(failed_list, list):
+                    failed_list.append(spec_id)
+                logger.error(f"Error processing SPEC {spec_id}: {e}")
+
+        logger.info(
+            f"Batch update complete: {len(results['updated'])} updated, "
+            f"{len(results['failed'])} failed, "
+            f"{len(results['skipped'])} skipped"
+        )
+        return results
+
+    # Private helper methods
+
+    def _check_acceptance_criteria(self, spec_file: Path) -> bool:
+        """
+        Check if SPEC file contains acceptance criteria
+
+        Args:
+            spec_file: Path to SPEC file
+
+        Returns:
+            True if acceptance criteria present
+        """
+        try:
+            with open(spec_file, "r", encoding="utf-8") as f:
+                content = f.read()
+
+            # Look for acceptance criteria section
+            acceptance_patterns = [
+                r"##\s*Acceptance\s+Criteria",
+                r"###\s*Acceptance\s+Criteria",
+                r"##\s*验收\s+标准",
+                r"###\s*验收\s+标准",
+            ]
+
+            for pattern in acceptance_patterns:
+                if re.search(pattern, content, re.IGNORECASE):
+                    return True
+
+            return False
+
+        except Exception as e:
+            logger.error(f"Error checking acceptance criteria in {spec_file}: {e}")
+            return False
+
+    def _check_documentation_sync(self, spec_id: str) -> bool:
+        """
+        Check if documentation is synchronized with implementation
+
+        Args:
+            spec_id: The SPEC identifier
+
+        Returns:
+            True if documentation appears synchronized
+        """
+        try:
+            # Simple heuristic: check if docs exist and are recent
+            docs_dir = self.project_root / "docs"
+            if not docs_dir.exists():
+                return True  # No docs to sync
+
+            # Check if there are any doc files related to this SPEC
+            spec_docs = list(docs_dir.rglob(f"*{spec_id.lower()}*"))
+            if not spec_docs:
+                return True  # No specific docs for this SPEC
+
+            # Basic check - assume docs are in sync if they exist
+            return True
+
+        except Exception as e:
+            logger.error(f"Error checking documentation sync for {spec_id}: {e}")
+            return False
+
+    def _run_additional_validations(self, spec_id: str) -> bool:
+        """Run additional validation checks for SPEC completion
+
+        Args:
+            spec_id: The SPEC identifier
+
+        Returns:
+            True if all additional validations pass
+        """
+        # Add any additional validation logic here
+        # For now, return True as default
+        return True
+
+    def _bump_version(self, current_version: str) -> str:
+        """Bump version to indicate completion
+
+        Args:
+            current_version: Current version string
+
+        Returns:
+            New version string
+        """
+        try:
+            # Parse current version - strip quotes if present
+            version = str(current_version).strip("\"'")
+
+            if version.startswith("0."):
+                # Major version bump for completion
+                return "1.0.0"
+            else:
+                # Minor version bump for updates
+                parts = version.split(".")
+                if len(parts) >= 2:
+                    try:
+                        minor = int(parts[1]) + 1
+                        return f"{parts[0]}.{minor}.0"
+                    except ValueError:
+                        # If parsing fails, default to 1.0.0
+                        return "1.0.0"
+                else:
+                    return f"{version}.1"
+
+        except Exception:
+            # Fallback to 1.0.0
+            return "1.0.0"

moai_adk/core/template/__init__.py

@@ -0,0 +1,7 @@
+"""Template management module."""
+
+from moai_adk.core.template.backup import TemplateBackup
+from moai_adk.core.template.merger import TemplateMerger
+from moai_adk.core.template.processor import TemplateProcessor
+
+__all__ = ["TemplateProcessor", "TemplateBackup", "TemplateMerger"]

moai_adk/core/template/backup.py

@@ -0,0 +1,174 @@
+"""Template backup manager (SPEC-INIT-003 v0.3.0).
+
+Creates and manages backups to protect user data during template updates.
+"""
+
+from __future__ import annotations
+
+import re
+import shutil
+from datetime import datetime
+from pathlib import Path
+
+
+class TemplateBackup:
+    """Create and manage template backups."""
+
+    # Paths excluded from backups (protect user data)
+    BACKUP_EXCLUDE_DIRS = [
+        "specs",  # User SPEC documents
+        "reports",  # User reports
+    ]
+
+    def __init__(self, target_path: Path) -> None:
+        """Initialize the backup manager.
+
+        Args:
+            target_path: Project path (absolute).
+        """
+        self.target_path = target_path.resolve()
+
+    @property
+    def backup_dir(self) -> Path:
+        """Get the backup directory path.
+
+        Returns:
+            Path to .moai-backups directory.
+        """
+        return self.target_path / ".moai-backups"
+
+    def has_existing_files(self) -> bool:
+        """Check whether backup-worthy files already exist.
+
+        Returns:
+            True when any tracked file exists.
+        """
+        return any((self.target_path / item).exists() for item in [".moai", ".claude", ".github", "CLAUDE.md"])
+
+    def create_backup(self) -> Path:
+        """Create a timestamped backup under .moai-backups/.
+
+        Creates a new timestamped backup directory for each update.
+        Maintains backward compatibility by supporting both new and legacy structures.
+
+        Returns:
+            Path to timestamped backup directory (e.g., .moai-backups/20241201_143022/).
+        """
+        # Generate timestamp for backup directory name
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+        backup_path = self.target_path / ".moai-backups" / timestamp
+
+        backup_path.mkdir(parents=True, exist_ok=True)
+
+        # Copy backup targets
+        for item in [".moai", ".claude", ".github", "CLAUDE.md"]:
+            src = self.target_path / item
+            if not src.exists():
+                continue
+
+            dst = backup_path / item
+
+            if item == ".moai":
+                # Copy while skipping protected paths
+                self._copy_exclude_protected(src, dst)
+            elif src.is_dir():
+                shutil.copytree(src, dst, dirs_exist_ok=True)
+            else:
+                shutil.copy2(src, dst)
+
+        return backup_path
+
+    def get_latest_backup(self) -> Path | None:
+        """Get the most recent backup, supporting both new and legacy structures.
+
+        Searches for backups in order of preference:
+        1. Latest timestamped backup (new structure)
+        2. Legacy backup/ directory (old structure)
+
+        Returns:
+            Path to the most recent backup directory, or None if no backups exist.
+        """
+        # Check for new timestamped backups first
+        backup_dir = self.target_path / ".moai-backups"
+        if backup_dir.exists():
+            # Match pattern: YYYYMMDD_HHMMSS (8 digits + underscore + 6 digits)
+            timestamp_pattern = re.compile(r"^\d{8}_\d{6}$")
+            timestamped_backups = [d for d in backup_dir.iterdir() if d.is_dir() and timestamp_pattern.match(d.name)]
+
+            if timestamped_backups:
+                # Sort by name (timestamp) and return the latest
+                latest_backup = max(timestamped_backups, key=lambda x: x.name)
+                return latest_backup
+
+        # Fall back to legacy backup/ directory
+        legacy_backup = backup_dir / "backup"
+        if legacy_backup.exists():
+            return legacy_backup
+
+        return None
+
+    def _copy_exclude_protected(self, src: Path, dst: Path) -> None:
+        """Copy backup content while excluding protected paths.
+
+        Args:
+            src: Source directory.
+            dst: Destination directory.
+        """
+        dst.mkdir(parents=True, exist_ok=True)
+
+        for item in src.rglob("*"):
+            rel_path = item.relative_to(src)
+            rel_path_str = str(rel_path)
+
+            # Skip excluded paths
+            if any(rel_path_str.startswith(exclude_dir) for exclude_dir in self.BACKUP_EXCLUDE_DIRS):
+                continue
+
+            dst_item = dst / rel_path
+            if item.is_file():
+                dst_item.parent.mkdir(parents=True, exist_ok=True)
+                shutil.copy2(item, dst_item)
+            elif item.is_dir():
+                dst_item.mkdir(parents=True, exist_ok=True)
+
+    def restore_backup(self, backup_path: Path | None = None) -> None:
+        """Restore project files from backup.
+
+        Restores .moai, .claude, .github directories and CLAUDE.md file
+        from a backup created by create_backup().
+        Supports both new timestamped and legacy backup structures.
+
+        Args:
+            backup_path: Backup path to restore from.
+                        If None, automatically finds the latest backup.
+
+        Raises:
+            FileNotFoundError: When no backup is found.
+        """
+        if backup_path is None:
+            backup_path = self.get_latest_backup()
+
+        if backup_path is None or not backup_path.exists():
+            raise FileNotFoundError(f"Backup not found: {backup_path}")
+
+        # Restore each item from backup
+        for item in [".moai", ".claude", ".github", "CLAUDE.md"]:
+            src = backup_path / item
+            dst = self.target_path / item
+
+            # Skip if not in backup
+            if not src.exists():
+                continue
+
+            # Remove current version
+            if dst.exists():
+                if dst.is_dir():
+                    shutil.rmtree(dst)
+                else:
+                    dst.unlink()
+
+            # Restore from backup
+            if src.is_dir():
+                shutil.copytree(src, dst, dirs_exist_ok=True)
+            else:
+                shutil.copy2(src, dst)