Merge pull request #3 from tldrwtf/feature/tests

Feature/tests

Author: tldrwtf

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, feature/** ]
+  pull_request:
+    branches: [ main, feature/** ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint
+        run: |
+          ruff check .
+          black --check .
+          isort --check-only .
+
+      - name: Run tests
+        run: |
+          pytest

docs/CONTRIBUTING.md

@@ -22,31 +22,35 @@
 ### Installation
 
 1. Clone the repository:
-```bash
-git clone https://github.com/tldrwtf/pokedo.git
-cd pokedo
-```
 
-2. Create a virtual environment:
-```bash
-python -m venv venv
+    ```bash
+    git clone https://github.com/tldrwtf/pokedo.git
+    cd pokedo
+    ```
 
-# Windows
-venv\Scripts\activate
+1. Create a virtual environment:
 
-# macOS/Linux
-source venv/bin/activate
-```
+    ```bash
+    python -m venv venv
 
-3. Install development dependencies:
-```bash
-pip install -e ".[dev]"
-```
+    # Windows
+    venv\Scripts\activate
 
-4. Initialize the application (for testing):
-```bash
-pokedo init --name "Developer" --quick
-```
+    # macOS/Linux
+    source venv/bin/activate
+    ```
+
+1. Install development dependencies (formatter, linter, tests):
+
+    ```bash
+    pip install -e ".[dev]"
+    ```
+
+1. Initialize the application (for testing):
+
+    ```bash
+    pokedo init --name "Developer" --quick
+    ```
 
 ### Development Commands
 
@@ -68,13 +72,22 @@ pytest tests/test_tasks.py
 
 # Run with verbose output
 pytest -v
+
+# Format code (Black)
+black .
+
+# Sort imports (isort profile=black)
+isort .
+
+# Lint (Ruff)
+ruff check .
 ```
 
 ---
 
 ## Project Structure
 
-```
+```text
 pokedo/
 ├── cli/                  # Command-line interface
 │   ├── app.py            # Main Typer application
@@ -213,7 +226,7 @@ def safe_operation() -> None:
 
 ### Test Structure
 
-```
+```text
 tests/
 ├── __init__.py
 ├── conftest.py           # Shared fixtures
@@ -334,7 +347,7 @@ def new_command(
     console.print(f"Running with {arg}")
 ```
 
-2. Register in `cli/app.py`:
+1. Register in `cli/app.py`:
 
 ```python
 from pokedo.cli.commands import example
@@ -357,7 +370,7 @@ class NewModel(BaseModel):
     created_at: datetime = Field(default_factory=datetime.now)
 ```
 
-2. Add database operations in `data/database.py`:
+1. Add database operations in `data/database.py`:
 
 ```python
 def create_new_model_table(self) -> None:
@@ -390,9 +403,9 @@ class NewWellbeingEntry(BaseModel):
     note: str | None = None
 ```
 
-2. Add database table in `data/database.py`
+1. Add database table in `data/database.py`
 
-3. Add CLI command in `cli/commands/wellbeing.py`:
+1. Add CLI command in `cli/commands/wellbeing.py`:
 
 ```python
 @app.command()
@@ -427,7 +440,7 @@ def new_tracker(
 
 ### Branch Naming
 
-```
+```text
 feature/add-trading-system
 bugfix/fix-evolution-crash
 docs/update-readme
@@ -438,7 +451,7 @@ refactor/simplify-catch-rate
 
 Follow conventional commit format:
 
-```
+```text
 feat: add Pokemon trading system
 fix: resolve crash when evolving shiny Pokemon
 docs: update installation instructions

docs/TROUBLESHOOTING.md

@@ -0,0 +1,57 @@
+# Troubleshooting Guide
+
+Common issues and their fixes while working on PokeDo.
+
+## Environment Setup
+
+### Missing Dependencies
+
+- **Symptom:** `ModuleNotFoundError` when running the CLI or tests.
+- **Fix:** Ensure the virtual environment is active and run `pip install -e ".[dev]"`.
+
+### Database Permission Errors
+
+- **Symptom:** `sqlite3.OperationalError: unable to open database file`.
+- **Fix:** Delete `~/.pokedo/pokedo.db` and rerun `pokedo init`. Confirm you have write access to the directory.
+
+## CLI Issues
+
+### Typer Option Errors
+
+- **Symptom:** `No such option` or `OptionInfo` type errors when calling shortcuts.
+- **Fix:** Use the namespaced command (`pokedo pokemon pokedex`) when you need advanced options. Shortcuts are guarded wrappers and may have fewer flags.
+
+### Pokedex Empty After Init
+
+- **Symptom:** `pokedo pokedex` shows empty data even after initializing.
+- **Fix:** Run `pokedo init --quick` again; ensure the PokeAPI requests succeeded and check for networking issues.
+
+## Testing Problems
+
+### Pytest Missing
+
+- **Symptom:** `No module named pytest`.
+- **Fix:** Install dev dependencies (`pip install -e ".[dev]"`) and rerun tests.
+
+### Database Tests Interfering with Local Data
+
+- **Symptom:** Tests modify your real `~/.pokedo` database.
+- **Fix:** Use the `isolated_db` fixture from `tests/conftest.py` and avoid importing the global `db` outside fixtures in tests.
+
+## Pydantic Model Errors
+
+### FieldInfo clashes
+
+- **Symptom:** `PydanticUserError: Error when building FieldInfo from annotated attribute`.
+- **Fix:** Ensure datetime/date fields use module-qualified names (`import datetime as dt`) or callable factories (e.g., `Field(default_factory=dt.date.today)`). Clear `__pycache__` if errors persist.
+
+## Logging and Debugging Tips
+
+- Set `POKEDO_DEBUG=1` (if implemented) or instrument CLI commands with temporary prints to trace logic.
+- Clear caches in `~/.pokedo/cache` if sprite downloads or API responses look stale.
+
+## Getting Support
+
+- Re-read `docs/CONTRIBUTING.md` for setup steps.
+- Check open issues in the repository for similar problems.
+- When filing a new issue, include OS, Python version, and exact command output.

pokedo/cli/app.py

@@ -1,20 +1,19 @@
 """Main CLI application for PokeDo."""
 
 import typer
+from rich import box
 from rich.console import Console
 from rich.panel import Panel
-from rich import box
 
 from pokedo import __version__
-from pokedo.cli.commands import tasks, pokemon, wellbeing, stats
+from pokedo.cli.commands import pokemon, stats, tasks, wellbeing
 from pokedo.data.database import db
-from pokedo.cli.ui.displays import display_trainer_card
 
 # Create main app
 app = typer.Typer(
     name="pokedo",
     help="PokeDo - A Pokemon-themed task manager and wellbeing tracker",
-    no_args_is_help=False
+    no_args_is_help=False,
 )
 
 # Register sub-commands
@@ -29,8 +28,7 @@
 # Direct commands (shortcuts)
 @app.command("mood")
 def mood_shortcut(
-    level: int = typer.Argument(..., min=1, max=5),
-    note: str = typer.Option(None, "--note", "-n")
+    level: int = typer.Argument(..., min=1, max=5), note: str = typer.Option(None, "--note", "-n")
 ) -> None:
     """Quick mood log (1-5)."""
     wellbeing.log_mood(level, note, None)
@@ -40,7 +38,7 @@ def mood_shortcut(
 def exercise_shortcut(
     exercise_type: wellbeing.ExerciseType = typer.Argument(...),
     duration: int = typer.Option(..., "--duration", "-d"),
-    intensity: int = typer.Option(3, "--intensity", "-i", min=1, max=5)
+    intensity: int = typer.Option(3, "--intensity", "-i", min=1, max=5),
 ) -> None:
     """Quick exercise log."""
     wellbeing.log_exercise(exercise_type, duration, intensity, None)
@@ -49,24 +47,20 @@ def exercise_shortcut(
 @app.command("sleep")
 def sleep_shortcut(
     hours: float = typer.Argument(...),
-    quality: int = typer.Option(3, "--quality", "-q", min=1, max=5)
+    quality: int = typer.Option(3, "--quality", "-q", min=1, max=5),
 ) -> None:
     """Quick sleep log."""
     wellbeing.log_sleep(hours, quality, None)
 
 
 @app.command("water")
-def water_shortcut(
-    glasses: int = typer.Option(1, "--glasses", "-g")
-) -> None:
+def water_shortcut(glasses: int = typer.Option(1, "--glasses", "-g")) -> None:
     """Quick water log."""
     wellbeing.log_hydration(glasses, None)
 
 
 @app.command("meditate")
-def meditate_shortcut(
-    minutes: int = typer.Argument(...)
-) -> None:
+def meditate_shortcut(minutes: int = typer.Argument(...)) -> None:
     """Quick meditation log."""
     wellbeing.log_meditation(minutes, None)
 
@@ -117,12 +111,13 @@ def show_version() -> None:
 def initialize(
     name: str = typer.Option("Trainer", "--name", "-n", help="Your trainer name"),
     quick: bool = typer.Option(False, "--quick", "-q", help="Quick init (Gen 1 only)"),
-    gen: int = typer.Option(0, "--gen", "-g", help="Initialize specific generation (1-9, 0=all)")
+    gen: int = typer.Option(0, "--gen", "-g", help="Initialize specific generation (1-9, 0=all)"),
 ) -> None:
     """Initialize PokeDo and create trainer profile."""
-    from pokedo.utils.config import config
     import asyncio
+
     from pokedo.data.pokeapi import pokeapi
+    from pokedo.utils.config import config
 
     console.print("[bold]Welcome to PokeDo![/bold]")
     console.print("Initializing your Pokemon journey...\n")
@@ -132,7 +127,7 @@ def initialize(
     console.print("[green]+ Created data directories[/green]")
 
     # Initialize database
-    trainer = db.get_or_create_trainer(name)
+    db.get_or_create_trainer(name)
     console.print(f"[green]+ Created trainer profile: {name}[/green]")
 
     # Determine range to initialize
@@ -191,10 +186,7 @@ def show_dashboard() -> None:
 
     # Header
     console.print()
-    console.print(Panel(
-        f"[bold]PokeDo[/bold] - {trainer.name}'s Journey",
-        box=box.DOUBLE
-    ))
+    console.print(Panel(f"[bold]PokeDo[/bold] - {trainer.name}'s Journey", box=box.DOUBLE))
 
     # Quick stats
     today = date.today()
@@ -212,10 +204,9 @@ def show_dashboard() -> None:
 
     # Team preview
     if team:
-        team_str = " | ".join([
-            f"{p.display_name} Lv.{p.level}" + (" *" if p.is_shiny else "")
-            for p in team[:3]
-        ])
+        team_str = " | ".join(
+            [f"{p.display_name} Lv.{p.level}" + (" *" if p.is_shiny else "") for p in team[:3]]
+        )
         console.print(f"\n[dim]Team:[/dim] {team_str}")
 
     # Today's tasks
@@ -230,7 +221,9 @@ def show_dashboard() -> None:
         console.print("\n[green]All tasks completed![/green]")
 
     # Commands hint
-    console.print("\n[dim]Commands: task add/complete | pokemon team/pokedex | daily | --help[/dim]")
+    console.print(
+        "\n[dim]Commands: task add/complete | pokemon team/pokedex | daily | --help[/dim]"
+    )
 
 
 if __name__ == "__main__":