# 機能設計書 28-git_commits_ahead

## 概要

本ドキュメントは、Oh My Zshの`git_commits_ahead`関数の機能設計を定義するものである。この関数は、ローカルブランチがリモートのupstreamブランチより先行しているコミット数を取得し、プロンプト表示用にフォーマットして出力する機能を提供する。

### 本機能の処理概要

`git_commits_ahead`関数は、`git rev-list --count @{upstream}..HEAD`コマンドを使用してローカルがリモートより先行しているコミット数を計算し、テーマ変数で装飾した形式で出力する。

**業務上の目的・背景**：開発者がローカルで作業を進めた際、リモートにプッシュしていないコミットがいくつあるかを把握することは重要である。この関数により、プロンプトに先行コミット数を表示することで、プッシュのタイミングを視覚的に確認できる。

**機能の利用シーン**：
- プロンプトにプッシュ待ちのコミット数を表示
- プッシュ前にローカルコミット数を確認
- 大量のコミットを蓄積する前に適切なタイミングでプッシュ

**主要な処理内容**：
1. Gitリポジトリ内であることを確認
2. `git rev-list --count @{upstream}..HEAD`でaheadコミット数を取得
3. コミット数が0より大きい場合のみ出力
4. テーマ変数（PREFIX/SUFFIX）でフォーマットして出力

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | シェルプロンプト | 主画面 | プロンプト表示時にaheadコミット数を出力 |

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- カレントディレクトリのGitリポジトリ情報
- テーマ変数（`ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX`、`ZSH_THEME_GIT_COMMITS_AHEAD_SUFFIX`）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| aheadコミット数 | 文字列 | `${PREFIX}${commits}${SUFFIX}`形式の文字列 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. Gitリポジトリ判定
   └─ git rev-parse --git-dir でGitリポジトリかチェック
2. aheadコミット数の取得
   └─ git rev-list --count @{upstream}..HEAD
3. コミット数の判定
   └─ 空でない かつ 0でない場合のみ処理続行
4. フォーマット文字列の生成と出力
   └─ ${PREFIX}${commits}${SUFFIX}
```

### フローチャート

```mermaid
flowchart TD
    A[開始: git_commits_ahead] --> B{Gitリポジトリ内?}
    B -->|No| C[何も出力せず終了]
    B -->|Yes| D[rev-list --count @{upstream}..HEAD]
    D --> E{commits取得成功?}
    E -->|No| C
    E -->|Yes| F{commits > 0?}
    F -->|No| C
    F -->|Yes| G[PREFIX + commits + SUFFIX を出力]
    G --> H[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-28-01 | リポジトリ判定 | Gitリポジトリ外では何も出力しない | 常時 |
| BR-28-02 | ゼロ除外 | コミット数が0の場合は何も出力しない | commits=0時 |
| BR-28-03 | 空除外 | コミット数が空の場合は何も出力しない | upstream未設定時など |
| BR-28-04 | フォーマット | PREFIX + コミット数 + SUFFIX の形式で出力 | 常時 |

### 計算ロジック

- **aheadコミット数**: `git rev-list --count @{upstream}..HEAD`
  - `@{upstream}`はローカルブランチの追跡リモートブランチ
  - `..HEAD`との差分でローカルにしかないコミットを計算

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ機能なし

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

該当なし

## パフォーマンス要件

- `GIT_OPTIONAL_LOCKS=0`を設定してGitコマンドを実行し、ロック競合を回避
- `--count`オプションで直接数値を取得し、`wc -l`より効率的

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

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

## 備考

- `@{upstream}`は`@{u}`と省略可能（Git 1.7.0以降）
- テーマ変数でプレフィックス/サフィックスをカスタマイズ可能（例：「↑」マーク）
- `git_commits_behind`関数と対になる機能

---

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

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

### 推奨読解順序

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

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

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

**主要なテーマ変数**:
- `ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX`: コミット数の前に表示する文字列（例：「↑」）
- `ZSH_THEME_GIT_COMMITS_AHEAD_SUFFIX`: コミット数の後に表示する文字列

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

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

**主要処理フロー**:
1. **293行目**: 関数のコメント
2. **294行目**: `git_commits_ahead`関数の定義開始
3. **295行目**: Gitリポジトリ判定 (`git rev-parse --git-dir`)
4. **296行目**: aheadコミット数を取得 (`rev-list --count @{upstream}..HEAD`)
5. **297行目**: 空でない かつ 0でない場合の条件分岐
6. **298行目**: テーマ変数を使用してフォーマット出力

**読解のコツ**:
- `if __git_prompt_git rev-parse --git-dir &>/dev/null; then`でGitリポジトリ判定
- `rev-list --count`は`wc -l`を使わず直接カウント値を返す
- `[[ -n "$commits" && "$commits" != 0 ]]`で空と0の両方をチェック

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

```
git_commits_ahead (ユーザー呼び出し/プロンプト展開)
    │
    ├─ __git_prompt_git rev-parse --git-dir
    │      └─ Gitリポジトリ判定
    │
    └─ __git_prompt_git rev-list --count @{upstream}..HEAD
           │
           └─ commits > 0 の場合
                  └─ echo "${PREFIX}${commits}${SUFFIX}"
```

### データフロー図

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

                        ┌─────────────────────┐
カレントディレクトリ ──▶│ rev-parse --git-dir │
                        │ Gitリポジトリ判定   │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ rev-list --count    │
                        │ @{upstream}..HEAD   │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ 条件判定            │
                        │ commits非空 かつ    │
                        │ commits != 0        │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
ZSH_THEME_GIT_         ▶│ フォーマット構築    │
COMMITS_AHEAD_PREFIX    │ ${PREFIX}${n}${SUFFIX}│
COMMITS_AHEAD_SUFFIX    └─────────────────────┘
                                  │
                                  ▼
                          標準出力（例：「↑3」）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| git.zsh | `lib/git.zsh` | ソース | git_commits_ahead関数の実装 |
| *.zsh-theme | `themes/*.zsh-theme` | テーマ | PREFIX/SUFFIX変数の定義 |
