オンボーディングドキュメントで定義すべきこと
環境構築から初タスクまで・Python 環境診断スクリプト

## 環境要件

| ツール | バージョン | インストール方法 |
|--------|-----------|----------------|
| Python | 3.12.x    | [pyenv](https://github.com/pyenv/pyenv) 推奨 |
| Node.js | 22.x LTS | [nvm](https://github.com/nvm-sh/nvm) 推奨 |
| Docker  | 26.x 以上 | [Docker Desktop](https://docs.docker.com/desktop/) |
| AWS CLI | 2.x       | `brew install awscli` |

## セットアップ手順

### 1. リポジトリのクローン

```bash
git clone git@github.com:example/my-app.git
cd my-app
```

### 2. Python 仮想環境の作成

```bash
pyenv install 3.12.4  # 初回のみ
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e ".[dev]"    # 開発依存も含めてインストール
```

### 3. 環境変数の設定

```bash
cp .env.example .env
# .env をエディタで開き、以下の値を設定する（Slack #dev-secrets に記載あり）:
# - DATABASE_URL
# - REDIS_URL
# - AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY
```

### 4. データベースのセットアップ

```bash
docker compose up -d db redis  # DB と Redis を起動
python manage.py migrate       # マイグレーション実行
python manage.py seed          # 初期データ投入
```

### 5. 動作確認

```bash
python manage.py runserver
# → http://localhost:8000 でアクセスできれば成功
```

## よくある問題

### `ModuleNotFoundError: No module named 'xxx'`
仮想環境が有効化されていない可能性があります。
`source .venv/bin/activate` を再実行してください。

### Docker が起動しない（Mac M1/M2）
`docker compose` コマンドで `platform: linux/amd64` を指定することで解決する場合があります。
→ 詳細: [Notion - M1 Mac セットアップ Tips](https://notion.so/xxx)

"""
開発環境の要件を自動チェックする診断スクリプト。
オンボーディング手順の最終ステップで実行する。

使い方:
  python scripts/check_env.py

全チェックが ✅ になれば環境構築完了。
"""
import shutil
import subprocess
import sys
import os
from dataclasses import dataclass


@dataclass
class Check:
    name: str
    result: bool
    detail: str
    hint: str = ""


def check_command_version(
    cmd: str, args: list[str], min_version: tuple[int, ...]
) -> Check:
    """コマンドが存在し、最低バージョンを満たすか確認する。"""
    if not shutil.which(cmd):
        return Check(cmd, False, "コマンドが見つかりません", f"`{cmd}` をインストールしてください")
    try:
        out = subprocess.check_output([cmd] + args, text=True, stderr=subprocess.STDOUT)
        # バージョン番号を抽出（"3.12.4" 形式を想定）
        import re
        m = re.search(r"(\d+)\.(\d+)\.?(\d*)", out)
        if not m:
            return Check(cmd, False, f"バージョンを解析できません: {out.strip()}")
        actual = tuple(int(x) for x in m.groups() if x)
        ok = actual >= min_version
        detail = ".".join(str(x) for x in actual)
        min_str = ".".join(str(x) for x in min_version)
        hint = f"{min_str} 以上が必要です" if not ok else ""
        return Check(cmd, ok, detail, hint)
    except subprocess.CalledProcessError as e:
        return Check(cmd, False, str(e))


def check_env_var(name: str) -> Check:
    """環境変数が設定されているか確認する。"""
    value = os.environ.get(name, "")
    if not value:
        return Check(
            f"env:{name}", False, "未設定",
            f"`.env` ファイルに `{name}` を設定してください（#dev-secrets を参照）"
        )
    # シークレット値の先頭4文字だけ表示
    masked = value[:4] + "..." if len(value) > 4 else "***"
    return Check(f"env:{name}", True, masked)


def check_docker_compose() -> Check:
    """Docker Compose で DB が起動しているか確認する。"""
    try:
        out = subprocess.check_output(
            ["docker", "compose", "ps", "--format", "json"],
            text=True, stderr=subprocess.DEVNULL
        )
        if "db" in out and "running" in out.lower():
            return Check("docker-compose db", True, "running")
        return Check(
            "docker-compose db", False, "DB コンテナが起動していません",
            "`docker compose up -d db` を実行してください"
        )
    except (subprocess.CalledProcessError, FileNotFoundError) as e:
        return Check("docker-compose db", False, str(e))


def run_all_checks() -> list[Check]:
    return [
        check_command_version("python", ["--version"], (3, 12, 0)),
        check_command_version("node", ["--version"], (22, 0, 0)),
        check_command_version("docker", ["--version"], (26, 0, 0)),
        check_command_version("aws", ["--version"], (2, 0, 0)),
        check_env_var("DATABASE_URL"),
        check_env_var("REDIS_URL"),
        check_env_var("AWS_ACCESS_KEY_ID"),
        check_docker_compose(),
    ]


if __name__ == "__main__":
    print("=" * 60)
    print("開発環境 診断レポート")
    print("=" * 60)

    checks = run_all_checks()
    passed = sum(1 for c in checks if c.result)
    failed = len(checks) - passed

    for c in checks:
        icon = "✅" if c.result else "❌"
        print(f"{icon} {c.name:<30} {c.detail}")
        if not c.result and c.hint:
            print(f"   → {c.hint}")

    print("-" * 60)
    print(f"結果: {passed}/{len(checks)} 件 OK")

    if failed > 0:
        print(f"\n⚠️  {failed} 件の問題があります。上記の hint を参照して修正してください。")
        print("解消できない場合は Slack #dev-general で質問してください。")
        sys.exit(1)
    else:
        print("\n🎉 すべての環境チェックが完了しました！開発を始めましょう。")

"""
requirements.txt や pyproject.toml に記載されたパッケージが
期待バージョンでインストールされているか確認する。

使い方:
  python scripts/check_packages.py
"""
import importlib.metadata
from pathlib import Path
import re

def parse_requirements(path: str) -> dict[str, str]:
    """requirements.txt からパッケージ名とバージョン制約を返す。"""
    reqs = {}
    for line in Path(path).read_text().splitlines():
        line = line.strip()
        if not line or line.startswith("#"):
            continue
        m = re.match(r"([\w\-]+)\s*(==|>=|<=|!=|~=)?\s*([\d.]+)?", line)
        if m:
            reqs[m.group(1).lower()] = f"{m.group(2) or ''}{m.group(3) or ''}"
    return reqs

def check_packages() -> None:
    requirements = parse_requirements("requirements.txt")
    print(f"{'パッケージ':<30} {'要件':<15} {'インストール済み':<20} {'OK'}")
    print("-" * 75)
    for pkg, req in sorted(requirements.items()):
        try:
            installed = importlib.metadata.version(pkg)
            print(f"{pkg:<30} {req:<15} {installed:<20} ✅")
        except importlib.metadata.PackageNotFoundError:
            print(f"{pkg:<30} {req:<15} {'未インストール':<20} ❌")

if __name__ == "__main__":
    check_packages()