# 機能設計書 27-git_remote_status

## 概要

本ドキュメントは、Oh My Zshの`git_remote_status`関数の機能設計を定義するものである。この関数は、ローカルブランチとリモートのupstreamブランチとの差分状態（ahead/behind/diverged/equal）を判定し、対応するテーマ変数の値を出力する機能を提供する。

### 本機能の処理概要

`git_remote_status`関数は、`git rev-list`コマンドを使用してローカルとリモートのコミット差分を計算し、ブランチがリモートより先行しているか、遅れているか、分岐しているか、同期しているかを判定してプロンプト表示用の文字列を生成する。

**業務上の目的・背景**：開発者がリモートリポジトリと同期を取りながら作業する際、ローカルブランチがリモートに対してどのような状態にあるかを把握することは重要である。プッシュが必要か、プルが必要か、コンフリクトの可能性があるかを視覚的に確認できる。

**機能の利用シーン**：
- プロンプトにリモートとの差分状態を表示
- プッシュ前にahead状態を確認
- プル前にbehind状態を確認
- diverged状態でコンフリクトの可能性を警告

**主要な処理内容**：
1. upstreamブランチの存在を確認
2. `git rev-list`でローカルがリモートより先行しているコミット数を計算
3. `git rev-list`でローカルがリモートより遅れているコミット数を計算
4. 4つの状態（equal/ahead/behind/diverged）を判定
5. テーマ変数を使用してステータス文字列を構築
6. 詳細モード時はコミット数も含めて出力

**関連システム・外部連携**：
- Gitコマンド（`git rev-parse`、`git rev-list`）

**権限による制御**：特になし。Gitリポジトリへのアクセス権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | シェルプロンプト | 主画面 | プロンプト表示時にリモート状態を出力 |

## 機能種別

情報取得・フォーマット処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | この関数は引数を取らない | - |

### 入力データソース

- カレントディレクトリのGitリポジトリ情報
- テーマ変数（`ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE`、`ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE`等）
- `hook_com[branch]`変数（vcs_infoから提供される現在のブランチ名）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ステータス文字列 | 文字列 | リモートとの差分状態を示す文字列 |

### 出力先

標準出力（プロンプト表示用）

### ステータス種別と対応するテーマ変数

| 状態 | 条件 | テーマ変数 |
|------|------|------------|
| equal | ahead=0 かつ behind=0 | `ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE` |
| ahead | ahead>0 かつ behind=0 | `ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE` |
| behind | ahead=0 かつ behind>0 | `ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE` |
| diverged | ahead>0 かつ behind>0 | `ZSH_THEME_GIT_PROMPT_DIVERGED_REMOTE` |

### 詳細モード用テーマ変数

| 変数名 | 説明 |
|--------|------|
| `ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED` | 詳細モードの有効化フラグ |
| `ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_PREFIX` | 詳細モード時のプレフィックス |
| `ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_SUFFIX` | 詳細モード時のサフィックス |
| `ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE_COLOR` | ahead表示の色 |
| `ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE_COLOR` | behind表示の色 |

## 処理フロー

### 処理シーケンス

```
1. upstreamブランチの確認
   └─ git rev-parse --verify {branch}@{upstream}
   └─ upstreamがない場合は何も出力せず終了
2. aheadコミット数の計算
   └─ git rev-list {branch}@{upstream}..HEAD | wc -l
3. behindコミット数の計算
   └─ git rev-list HEAD..{branch}@{upstream} | wc -l
4. 状態の判定
   └─ equal: ahead=0 かつ behind=0
   └─ ahead: ahead>0 かつ behind=0
   └─ behind: ahead=0 かつ behind>0
   └─ diverged: ahead>0 かつ behind>0
5. 詳細モードのチェック
   └─ ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED設定時は詳細出力
6. ステータス文字列の出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始: git_remote_status] --> B[upstreamブランチ取得]
    B --> C{upstream存在?}
    C -->|No| D[何も出力せず終了]
    C -->|Yes| E[aheadコミット数を計算]
    E --> F[behindコミット数を計算]
    F --> G{ahead=0 かつ behind=0?}
    G -->|Yes| H[EQUAL_REMOTE]
    G -->|No| I{ahead>0 かつ behind=0?}
    I -->|Yes| J[AHEAD_REMOTE]
    I -->|No| K{ahead=0 かつ behind>0?}
    K -->|Yes| L[BEHIND_REMOTE]
    K -->|No| M[DIVERGED_REMOTE]
    H --> N{詳細モード?}
    J --> N
    L --> N
    M --> N
    N -->|Yes| O[詳細フォーマットで出力]
    N -->|No| P[シンプルフォーマットで出力]
    O --> Q[終了]
    P --> Q
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-27-01 | upstream必須 | upstreamブランチが設定されていない場合は何も出力しない | upstream未設定時 |
| BR-27-02 | equal判定 | ahead=0かつbehind=0の場合はequal状態 | 常時 |
| BR-27-03 | diverged判定 | ahead>0かつbehind>0の場合はdiverged状態 | 常時 |
| BR-27-04 | 詳細モード | `ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED`設定時は詳細出力 | 設定時 |
| BR-27-05 | リモート名表示 | 詳細モード時はリモート名も表示 | 詳細モード時 |

### 計算ロジック

- **aheadコミット数**: `git rev-list {upstream}..HEAD | wc -l`
- **behindコミット数**: `git rev-list HEAD..{upstream} | wc -l`

## データベース操作仕様

### 操作別データベース影響一覧

該当なし（データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | upstream未設定 | リモート追跡ブランチが設定されていない | 何も出力せずにリターン |

### リトライ仕様

リトライ機能なし

## トランザクション仕様

該当なし

## パフォーマンス要件

- `GIT_OPTIONAL_LOCKS=0`を設定してGitコマンドを実行し、ロック競合を回避
- `wc -l`でコミット数を効率的にカウント

## セキュリティ考慮事項

- 読み取り専用のGit操作のみを実行
- `GIT_OPTIONAL_LOCKS=0`によりファイルロックを取得しない

## 備考

- `hook_com[branch]`はvcs_infoのフック関数から渡される変数
- 詳細モードではリモート名とコミット数を色付きで表示可能
- `%{$reset_color%}`でANSIカラーをリセット

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、この機能で使用されるテーマ変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | テーマファイル | `themes/*.zsh-theme` | ZSH_THEME_GIT_PROMPT_*_REMOTE変数の定義 |

**主要なテーマ変数**:
- `ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE`: 同期状態のマーカー
- `ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE`: ahead状態のマーカー
- `ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE`: behind状態のマーカー
- `ZSH_THEME_GIT_PROMPT_DIVERGED_REMOTE`: diverged状態のマーカー
- `ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED`: 詳細モードフラグ

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | git.zsh | `lib/git.zsh` | git_remote_status関数の実装を確認 |

**主要処理フロー**:
1. **236-237行目**: 関数のコメント
2. **237行目**: `git_remote_status`関数の定義開始
3. **238行目**: ローカル変数の宣言
4. **239行目**: upstreamブランチ参照を取得し、`refs/remotes/`を除去
5. **240行目**: upstreamが存在する場合のみ処理続行
6. **241行目**: aheadコミット数を計算
7. **242行目**: behindコミット数を計算
8. **244-255行目**: 4つの状態を判定して対応するテーマ変数を設定
9. **257-259行目**: 詳細モード時の追加フォーマット
10. **261行目**: 結果を出力

**読解のコツ**:
- `${hook_com[branch]}`はvcs_infoのフック関数内で使用される変数
- `${$(...)/refs\/remotes\/}`でパラメータ展開と置換を組み合わせている
- 詳細モードでは`$git_remote_status_detailed`変数も構築される

### プログラム呼び出し階層図

```
git_remote_status (ユーザー呼び出し/プロンプト展開)
    │
    ├─ __git_prompt_git rev-parse --verify {branch}@{upstream}
    │      └─ upstream参照の取得とrefs/remotes/除去
    │
    ├─ __git_prompt_git rev-list {upstream}..HEAD | wc -l
    │      └─ aheadコミット数の計算
    │
    ├─ __git_prompt_git rev-list HEAD..{upstream} | wc -l
    │      └─ behindコミット数の計算
    │
    └─ 状態判定 → テーマ変数選択 → 出力
```

### データフロー図

```
[入力]                      [処理]                         [出力]

                        ┌─────────────────────┐
hook_com[branch] ─────▶│ upstream参照取得     │
                        │ @{upstream}         │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ ahead/behind計算    │
                        │ rev-list | wc -l    │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ 状態判定            │
                        │ equal/ahead/        │
                        │ behind/diverged     │
                        └─────────────────────┘
                                  │
              ┌───────────────────┼───────────────────┐
              ▼                   ▼                   ▼
        シンプル            詳細モード            diverged
        モード                                    詳細モード
              │                   │                   │
              ▼                   ▼                   ▼
         単一マーカー      リモート名+            ahead+behind
                          ahead/behind数          両方表示
              │                   │                   │
              └───────────────┬───────────────────────┘
                              ▼
                          標準出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| git.zsh | `lib/git.zsh` | ソース | git_remote_status関数の実装 |
| *.zsh-theme | `themes/*.zsh-theme` | テーマ | リモート状態マーカーの定義 |
