# 機能設計書 25-git_current_branch

## 概要

本ドキュメントは、Oh My Zshの`git_current_branch`関数の機能設計を定義するものである。この関数は、現在チェックアウトしているGitブランチ名を出力する機能を提供する。

### 本機能の処理概要

`git_current_branch`関数は、`git symbolic-ref`コマンドを使用して現在のHEADが指すブランチ名を取得し、出力する。デタッチドHEAD状態の場合は短縮コミットSHAを出力する。

**業務上の目的・背景**：開発者がスクリプトやコマンドで現在のブランチ名を参照する必要がある場面は多い。例えば`git pull origin $(git_current_branch)`のように、他のGitコマンドの引数として使用することで、ブランチ名を手動で入力する手間を省ける。

**機能の利用シーン**：
- `git pull origin $(git_current_branch)`でリモートから現在のブランチをプル
- `git push origin $(git_current_branch)`で現在のブランチをプッシュ
- シェルスクリプト内でブランチ名に応じた処理分岐
- プロンプトにブランチ名を表示する際の情報取得

**主要な処理内容**：
1. `git symbolic-ref --quiet HEAD`でブランチ参照を取得
2. 取得失敗時の戻り値を確認
3. 戻り値が128の場合はGitリポジトリ外のため終了
4. その他の失敗時は`git rev-parse --short HEAD`でコミットSHAを取得
5. `refs/heads/`プレフィックスを除去してブランチ名を出力

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | シェルプロンプト | 参照画面 | プロンプトやスクリプトからブランチ名を取得 |

## 機能種別

情報取得処理

## 入力仕様

### 入力パラメータ

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

### 入力データソース

カレントディレクトリのGitリポジトリ情報

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ブランチ名 | 文字列 | 現在のブランチ名（例：`main`、`feature/new-feature`） |
| コミットSHA | 文字列 | デタッチドHEAD時の短縮SHA（例：`abc1234`） |

### 出力先

標準出力

## 処理フロー

### 処理シーケンス

```
1. git symbolic-ref --quiet HEADを実行
   └─ 成功時：refs/heads/ブランチ名 を取得
2. 戻り値を確認
   └─ 0：成功、処理続行
   └─ 128：Gitリポジトリ外、即終了
   └─ その他：デタッチドHEAD状態
3. デタッチドHEAD時
   └─ git rev-parse --short HEADで短縮SHAを取得
4. refs/heads/プレフィックスを除去
5. ブランチ名（またはSHA）を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始: git_current_branch] --> B[git symbolic-ref --quiet HEAD]
    B --> C{戻り値=0?}
    C -->|Yes| D[refs/heads/を除去]
    C -->|No| E{戻り値=128?}
    E -->|Yes| F[Gitリポジトリ外:終了]
    E -->|No| G[git rev-parse --short HEAD]
    G --> H{取得成功?}
    H -->|No| F
    H -->|Yes| I[短縮SHAをrefに設定]
    D --> J[echo ブランチ名]
    I --> J
    J --> K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-25-01 | ブランチ名優先 | symbolic-refで取得できる場合はブランチ名を返す | symbolic-ref成功時 |
| BR-25-02 | フォールバック | デタッチドHEAD時は短縮SHAを返す | symbolic-ref失敗時 |
| BR-25-03 | プレフィックス除去 | `refs/heads/`プレフィックスは除去して出力 | 常時 |
| BR-25-04 | 静音モード | `--quiet`フラグでエラーメッセージを抑制 | 常時 |

### 計算ロジック

該当なし

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 128 | 非Gitリポジトリ | Gitリポジトリ外で実行 | 何も出力せずにリターン |
| 非0 | デタッチドHEAD | ブランチにチェックアウトしていない | rev-parse --shortでSHA取得 |

### リトライ仕様

リトライ機能なし

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

該当なし

## パフォーマンス要件

- `GIT_OPTIONAL_LOCKS=0`を設定してGitコマンドを実行し、ロック競合を回避
- `--quiet`フラグでエラー出力を抑制し、パイプライン処理を効率化

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

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

## 備考

- コマンド置換`$(git_current_branch)`で他のコマンドの引数として使用可能
- デタッチドHEAD状態でも短縮SHAを返すため、操作は継続可能
- `--quiet`フラグにより、非ブランチ状態でも致命的エラー（128）を出さない

---

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

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

### 推奨読解順序

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

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

**主要処理フロー**:
1. **265-268行目**: 関数のコメント（使用例を含む）
2. **269行目**: `git_current_branch`関数の定義開始
3. **270行目**: ローカル変数`ref`の宣言
4. **271行目**: `symbolic-ref --quiet HEAD`でブランチ参照を取得
5. **272行目**: 戻り値を`ret`に保存
6. **273行目**: 戻り値が0でない場合の分岐
7. **274行目**: 戻り値が128の場合（非Gitリポジトリ）はリターン
8. **275行目**: デタッチドHEAD時は`rev-parse --short HEAD`でSHA取得
9. **277行目**: `${ref#refs/heads/}`でプレフィックスを除去して出力

**読解のコツ**:
- `symbolic-ref --quiet HEAD`は`--quiet`オプションにより、非symbolic-ref状態でも致命的エラーを出さない
- `${ref#refs/heads/}`はzshのパラメータ展開で、先頭から`refs/heads/`を除去
- 戻り値128はGitリポジトリ外を意味する標準的なGitエラーコード

#### Step 2: 関連関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | git.zsh | `lib/git.zsh` | __git_prompt_git関数（10-12行目） |

**主要処理**:
- `GIT_OPTIONAL_LOCKS=0`環境変数を設定してgitコマンドを実行
- ファイルロックを取得しないため、他のgitプロセスとの競合を回避

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

```
git_current_branch (ユーザー呼び出し)
    │
    ├─ __git_prompt_git symbolic-ref --quiet HEAD
    │      └─ ブランチ参照を取得
    │
    └─【失敗時（非128）】
        └─ __git_prompt_git rev-parse --short HEAD
               └─ 短縮SHAを取得
```

### データフロー図

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

                        ┌─────────────────────┐
カレントディレクトリ ──▶│ symbolic-ref HEAD   │
                        │ --quiet             │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ 戻り値判定          │
                        │ 0: 成功             │
                        │ 128: 非Git          │
                        │ 他: デタッチド      │
                        └─────────────────────┘
                                  │
              ┌───────────────────┼───────────────────┐
              ▼                   ▼                   ▼
         成功              非Gitリポジトリ      デタッチドHEAD
              │                   │                   │
              ▼                   ▼                   ▼
    refs/heads/除去          何も出力せず      rev-parse --short
              │              リターン                 │
              ▼                                       ▼
         ブランチ名 ─────────────────────────▶ 短縮SHA
              │                                       │
              └───────────────┬───────────────────────┘
                              ▼
                          標準出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| git.zsh | `lib/git.zsh` | ソース | git_current_branch関数の実装 |
