@opslane/claude-code-game 0.1.0

package/levels/04-planning-mode/exercise/models.py

@@ -0,0 +1,116 @@
+"""Expense data models and core operations."""
+
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Optional
+import uuid
+from database import save_expense, load_expenses, remove_expense, get_expense_by_id
+
+
+@dataclass
+class Expense:
+    """Represents a single expense entry."""
+    id: str
+    amount: float
+    category: str
+    description: str
+    date: datetime
+    recurring: bool = False
+    recurring_frequency: Optional[str] = None  # 'daily', 'weekly', 'monthly'
+
+
+def generate_id() -> str:
+    """Generate a unique expense ID."""
+    return str(uuid.uuid4())[:8]
+
+
+def add_expense(
+    amount: float,
+    category: str,
+    description: str,
+    date: Optional[datetime] = None
+) -> Expense:
+    """Add a new expense with validation."""
+    if amount <= 0:
+        raise ValueError("Amount must be greater than 0")
+
+    if not category or not category.strip():
+        raise ValueError("Category cannot be empty")
+
+    expense = Expense(
+        id=generate_id(),
+        amount=amount,
+        category=category.strip(),
+        description=description,
+        date=date or datetime.now()
+    )
+    save_expense(expense)
+    return expense
+
+
+def list_expenses(
+    category: Optional[str] = None,
+    month: Optional[str] = None,
+    limit: int = 100
+) -> list[Expense]:
+    """List expenses with optional filters."""
+    expenses = load_expenses()
+
+    if category:
+        category_lower = category.lower()
+        expenses = [e for e in expenses if e.category.lower() == category_lower]
+
+    if month:
+        expenses = [e for e in expenses if e.date.strftime('%Y-%m') == month]
+
+    expenses.sort(key=lambda x: x.date, reverse=True)
+    return expenses[:limit]
+
+
+def get_expense(expense_id: str) -> Optional[Expense]:
+    """Get a single expense by ID.
+
+    Args:
+        expense_id: The unique expense ID
+
+    Returns:
+        The Expense if found, None otherwise
+    """
+    return get_expense_by_id(expense_id)
+
+
+def delete_expense(expense_id: str) -> bool:
+    """Delete an expense by ID.
+
+    Args:
+        expense_id: The unique expense ID
+
+    Returns:
+        True if deleted, False if not found
+    """
+    return remove_expense(expense_id)
+
+
+def get_total_by_category(category: str) -> float:
+    """Get total spent in a category.
+
+    Args:
+        category: The category name
+
+    Returns:
+        Total amount spent in that category
+
+    Note: Also case-sensitive - shares bug with list_expenses.
+    """
+    expenses = list_expenses(category=category)
+    return sum(e.amount for e in expenses)
+
+
+def get_categories() -> list[str]:
+    """Get all unique categories from expenses.
+
+    Returns:
+        List of category names
+    """
+    expenses = load_expenses()
+    return list(set(e.category for e in expenses))

package/levels/04-planning-mode/exercise/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "expense-tracker"
+version = "0.1.0"
+description = "A simple CLI expense tracker for the Claude Code course"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+
+# No runtime dependencies - uses only stdlib
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.1.0",
+]
+
+[project.scripts]
+expense = "main:main"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"
+filterwarnings = [
+    "ignore::DeprecationWarning",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "F",      # pyflakes
+    "I",      # isort
+    "N",      # pep8-naming
+    "W",      # pycodestyle warnings
+    "UP",     # pyupgrade
+]
+ignore = [
+    "E501",   # Line too long (handled by formatter)
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["models", "database", "utils", "reports"]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

package/levels/04-planning-mode/exercise/reports.py

@@ -0,0 +1,138 @@
+"""Report generation for expense tracker.
+
+This module generates expense reports with summaries and breakdowns.
+
+TODO: This module is incomplete. Students implement it in Lesson 4.
+
+Features to implement:
+- Monthly expense report
+- Category breakdown
+- Top expenses list
+- Export to markdown file
+"""
+
+from datetime import datetime
+from pathlib import Path
+from typing import Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from models import Expense
+
+
+def generate_monthly_report(month: Optional[str] = None) -> str:
+    """Generate a monthly expense report.
+
+    Args:
+        month: Month in YYYY-MM format. Defaults to current month.
+
+    Returns:
+        Formatted report as a string.
+
+    The report should include:
+    - Total spent
+    - Number of expenses
+    - Breakdown by category with percentages
+    - Top 5 expenses
+
+    TODO (Lesson 4): Implement this function.
+    """
+    raise NotImplementedError(
+        "Implement this in Lesson 4! "
+        "The function should return a formatted report string."
+    )
+
+
+def get_category_breakdown(expenses: list["Expense"]) -> dict[str, float]:
+    """Get spending breakdown by category.
+
+    Args:
+        expenses: List of Expense objects
+
+    Returns:
+        Dictionary mapping category name to total amount
+
+    Example:
+        >>> expenses = [Expense(..., category="Food", amount=50), ...]
+        >>> get_category_breakdown(expenses)
+        {'Food': 75.0, 'Transport': 30.0}
+
+    TODO (Lesson 4): Implement this function.
+    """
+    raise NotImplementedError(
+        "Implement this in Lesson 4! "
+        "Sum amounts by category and return as dict."
+    )
+
+
+def get_top_expenses(expenses: list["Expense"], n: int = 5) -> list["Expense"]:
+    """Get the top N expenses by amount.
+
+    Args:
+        expenses: List of Expense objects
+        n: Number of top expenses to return (default 5)
+
+    Returns:
+        List of the N highest expenses, sorted by amount descending
+
+    TODO (Lesson 4): Implement this function.
+    """
+    raise NotImplementedError(
+        "Implement this in Lesson 4! "
+        "Sort by amount and return top N."
+    )
+
+
+def save_report(report: str, filename: str) -> Path:
+    """Save report to a file in the reports directory.
+
+    Args:
+        report: The report content as a string
+        filename: Name of the file (e.g., '2026-01.md')
+
+    Returns:
+        Path to the saved file
+
+    Creates the reports/ directory if it doesn't exist.
+
+    TODO (Lesson 4): Implement this function.
+    """
+    raise NotImplementedError(
+        "Implement this in Lesson 4! "
+        "Save to reports/{filename} and return the path."
+    )
+
+
+# Reference implementation (for instructor use)
+# Students should implement similar logic:
+#
+# def generate_monthly_report(month: Optional[str] = None) -> str:
+#     from models import list_expenses
+#     from utils import format_currency
+#
+#     if month is None:
+#         month = datetime.now().strftime("%Y-%m")
+#
+#     expenses = list_expenses(month=month)
+#
+#     if not expenses:
+#         return f"# Expense Report: {month}\n\nNo expenses found."
+#
+#     total = sum(e.amount for e in expenses)
+#     breakdown = get_category_breakdown(expenses)
+#     top = get_top_expenses(expenses, 5)
+#
+#     report = f"# Expense Report: {month}\n\n"
+#     report += f"## Summary\n"
+#     report += f"- **Total Spent:** {format_currency(total)}\n"
+#     report += f"- **Number of Expenses:** {len(expenses)}\n\n"
+#
+#     report += "## By Category\n"
+#     for cat, amount in sorted(breakdown.items(), key=lambda x: x[1], reverse=True):
+#         pct = (amount / total) * 100
+#         report += f"- {cat}: {format_currency(amount)} ({pct:.1f}%)\n"
+#
+#     report += "\n## Top 5 Expenses\n"
+#     for i, exp in enumerate(top, 1):
+#         report += f"{i}. {format_currency(exp.amount)} - {exp.description} ({exp.category})\n"
+#
+#     return report

package/levels/04-planning-mode/exercise/seed_data.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python3
+"""Seed the database with sample expenses for learning.
+
+Run this script to populate the database with example data:
+    python seed_data.py
+
+This creates a realistic set of expenses for students to work with.
+"""
+
+from datetime import datetime
+from database import init_db, clear_all_expenses
+from models import add_expense
+
+# Sample expenses for the course
+# Note: One entry has lowercase "food" to trigger the case-sensitivity bug
+SAMPLE_EXPENSES = [
+    # January 2026 - Primary month for exercises
+    (45.50, "Food", "Grocery shopping at Whole Foods", "2026-01-15"),
+    (12.00, "Transport", "Uber to airport", "2026-01-14"),
+    (89.99, "Shopping", "Running shoes from Nike", "2026-01-10"),
+    (150.00, "Bills", "Electric bill", "2026-01-01"),
+    (8.50, "food", "Coffee at Starbucks", "2026-01-20"),  # lowercase - triggers bug!
+    (35.00, "Entertainment", "Movie tickets for two", "2026-01-18"),
+    (22.00, "Food", "Lunch with team", "2026-01-19"),
+    (65.00, "Health", "Gym membership monthly", "2026-01-01"),
+    (15.75, "Food", "Thai takeout dinner", "2026-01-17"),
+    (42.00, "Transport", "Weekly metro pass", "2026-01-13"),
+    (28.99, "Entertainment", "Netflix + Spotify", "2026-01-05"),
+    (120.00, "Shopping", "Winter jacket on sale", "2026-01-08"),
+
+    # December 2025 - For month filtering tests
+    (200.00, "Shopping", "Holiday gifts for family", "2025-12-20"),
+    (55.00, "Food", "Holiday dinner groceries", "2025-12-25"),
+    (75.00, "Entertainment", "Concert tickets", "2025-12-15"),
+    (30.00, "Transport", "Airport parking", "2025-12-23"),
+
+    # November 2025 - Additional historical data
+    (95.00, "Bills", "Internet bill", "2025-11-15"),
+    (180.00, "Health", "Doctor visit copay", "2025-11-10"),
+    (45.00, "Food", "Birthday dinner", "2025-11-22"),
+]
+
+
+def seed_database(verbose: bool = True) -> int:
+    """Initialize and seed the database with sample data.
+
+    Args:
+        verbose: Whether to print progress messages
+
+    Returns:
+        Number of expenses added
+    """
+    if verbose:
+        print("Initializing database...")
+    init_db()
+
+    if verbose:
+        print("Clearing existing data...")
+    clear_all_expenses()
+
+    if verbose:
+        print("Adding sample expenses...")
+
+    count = 0
+    for amount, category, desc, date_str in SAMPLE_EXPENSES:
+        date = datetime.strptime(date_str, "%Y-%m-%d")
+        expense = add_expense(amount, category, desc, date)
+        count += 1
+        if verbose:
+            print(f"  Added: {expense.id} - ${amount:.2f} - {desc[:40]}")
+
+    if verbose:
+        print(f"\n{'='*50}")
+        print(f"Seeded {count} expenses successfully!")
+        print(f"{'='*50}")
+        print("\nTry these commands:")
+        print("  python main.py list")
+        print("  python main.py list --category Food")
+        print("  python main.py summary")
+        print("  pytest -v")
+
+    return count
+
+
+def main():
+    """Entry point for seeding script."""
+    seed_database()
+
+
+if __name__ == "__main__":
+    main()

package/levels/04-planning-mode/exercise/tests/__init__.py

@@ -0,0 +1 @@
+"""Test package for expense tracker."""

package/levels/04-planning-mode/exercise/tests/conftest.py

@@ -0,0 +1,69 @@
+"""Pytest configuration and shared fixtures."""
+
+import os
+import sys
+import pytest
+from pathlib import Path
+
+# Add parent directory to path so we can import our modules
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+# Use a separate test database
+TEST_DB_PATH = Path(__file__).parent / "test_expenses.db"
+os.environ["EXPENSE_DB_PATH"] = str(TEST_DB_PATH)
+
+
+@pytest.fixture(autouse=True)
+def clean_test_db():
+    """Ensure clean database for each test.
+
+    This fixture runs automatically before and after each test.
+    It initializes the database and cleans up after.
+    """
+    from database import init_db, clear_all_expenses
+
+    # Setup: initialize fresh database
+    init_db()
+    clear_all_expenses()
+
+    yield  # Run the test
+
+    # Teardown: clean up
+    clear_all_expenses()
+
+
+@pytest.fixture
+def sample_expenses():
+    """Create a set of sample expenses for testing.
+
+    Returns:
+        List of created Expense objects
+    """
+    from datetime import datetime
+    from models import add_expense
+
+    expenses = [
+        add_expense(50.00, "Food", "Groceries", datetime(2026, 1, 15)),
+        add_expense(30.00, "Transport", "Uber ride", datetime(2026, 1, 14)),
+        add_expense(25.00, "Food", "Lunch", datetime(2026, 1, 16)),
+        add_expense(100.00, "Shopping", "Clothes", datetime(2026, 1, 10)),
+        add_expense(15.00, "Entertainment", "Movie", datetime(2026, 1, 12)),
+    ]
+    return expenses
+
+
+@pytest.fixture
+def mixed_case_expenses():
+    """Create expenses with mixed case categories for bug testing.
+
+    This fixture specifically tests the case-sensitivity bug.
+    """
+    from datetime import datetime
+    from models import add_expense
+
+    expenses = [
+        add_expense(50.00, "Food", "Groceries", datetime(2026, 1, 15)),
+        add_expense(25.00, "food", "Coffee", datetime(2026, 1, 16)),  # lowercase
+        add_expense(30.00, "FOOD", "Dinner", datetime(2026, 1, 17)),  # uppercase
+    ]
+    return expenses