# 機能設計書 26-git_previous_branch

## 概要

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

### 本機能の処理概要

`git_previous_branch`関数は、`git rev-parse --symbolic-full-name @{-1}`コマンドを使用して、直前にチェックアウトしていたブランチの参照を取得し、ブランチ名として出力する。

**業務上の目的・背景**：開発者がブランチを頻繁に切り替えながら作業する際、直前のブランチに戻りたい場面は多い。`git checkout -`で戻ることはできるが、直前のブランチ名を参照したい場合（例：マージやプル操作）にこの関数が役立つ。

**機能の利用シーン**：
- `git merge $(git_previous_branch)`で直前のブランチをマージ
- `git pull origin $(git_previous_branch)`で直前のブランチからプル
- ブランチ切り替え履歴を確認するスクリプトで使用
- 複数ブランチ間を行き来する開発ワークフローで活用

**主要な処理内容**：
1. `git rev-parse --quiet --symbolic-full-name @{-1}`で直前のブランチ参照を取得
2. 戻り値をチェック
3. 参照が空でないことを確認（非ブランチ参照の場合は空になる）
4. `refs/heads/`プレフィックスを除去してブランチ名を出力

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

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

## 関連画面

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

## 機能種別

情報取得処理

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ブランチ名 | 文字列 | 直前にチェックアウトしていたブランチ名（例：`main`、`develop`） |

### 出力先

標準出力

## 処理フロー

### 処理シーケンス

```
1. git rev-parse --quiet --symbolic-full-name @{-1}を実行
   └─ 成功時：refs/heads/ブランチ名 を取得
2. 戻り値を確認
   └─ 0以外の場合は終了
3. 参照が空でないことを確認
   └─ 空の場合は終了（直前がコミットSHAだった場合など）
4. refs/heads/プレフィックスを除去
5. ブランチ名を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始: git_previous_branch] --> B[git rev-parse --quiet --symbolic-full-name @{-1}]
    B --> C{戻り値=0?}
    C -->|No| D[何も出力せず終了]
    C -->|Yes| E{refが空?}
    E -->|Yes| D
    E -->|No| F[refs/heads/を除去]
    F --> G[echo ブランチ名]
    G --> H[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-26-01 | ブランチ参照のみ | `@{-1}`がブランチを指す場合のみ出力する | 常時 |
| BR-26-02 | プレフィックス除去 | `refs/heads/`プレフィックスは除去して出力 | 常時 |
| BR-26-03 | 静音モード | `--quiet`フラグでエラーメッセージを抑制 | 常時 |
| BR-26-04 | 空チェック | 参照が空の場合（非ブランチ）は何も出力しない | ref空時 |

### 計算ロジック

該当なし

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | 参照取得失敗 | Gitリポジトリ外、またはreflogがない | 何も出力せずにリターン |
| - | 空参照 | 直前の参照がブランチでない（コミットSHAなど） | 何も出力せずにリターン |

### リトライ仕様

リトライ機能なし

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

該当なし

## パフォーマンス要件

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

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

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

## 備考

- `@{-1}`はGitのreflog記法で、「1つ前にチェックアウトしていた参照」を意味する
- `--symbolic-full-name`オプションにより、コミットSHAではなくブランチ参照を取得
- 直前の参照がブランチでない場合（例：特定コミットをチェックアウトした場合）は空が返る
- `git checkout -`と同様の情報源を使用

---

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

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

### 推奨読解順序

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

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

**主要処理フロー**:
1. **280-282行目**: 関数のコメント（使用例と説明）
2. **283行目**: `git_previous_branch`関数の定義開始
3. **284行目**: ローカル変数`ref`の宣言
4. **285行目**: `rev-parse --quiet --symbolic-full-name @{-1}`で直前ブランチ参照を取得
5. **286行目**: 戻り値を`ret`に保存
6. **287行目**: 戻り値が0でない、または`ref`が空の場合はリターン
7. **290行目**: `${ref#refs/heads/}`でプレフィックスを除去して出力

**読解のコツ**:
- `@{-1}`はGitの特殊参照で、「前回チェックアウトしていた参照」を意味
- `--symbolic-full-name`は参照を完全な形式（`refs/heads/...`）で返す
- 直前の参照がコミットSHAの場合、`--symbolic-full-name`は空を返すため`-z $ref`チェックが必要

#### Step 2: Git参照記法を理解する

| 順序 | 項目 | 説明 |
|-----|------|------|
| 2-1 | `@{-1}` | 1つ前にチェックアウトしていた参照 |
| 2-2 | `@{-2}` | 2つ前にチェックアウトしていた参照 |
| 2-3 | `--symbolic-full-name` | SHA ではなく完全な参照名を返す |

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

```
git_previous_branch (ユーザー呼び出し)
    │
    └─ __git_prompt_git rev-parse --quiet --symbolic-full-name @{-1}
           │
           ├─ 成功かつ非空：refs/heads/除去 → ブランチ名出力
           │
           └─ 失敗または空：何も出力せずリターン
```

### データフロー図

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

                        ┌─────────────────────┐
Gitリポジトリ ─────────▶│ rev-parse           │
reflog                  │ --symbolic-full-name│
                        │ @{-1}               │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ 結果判定            │
                        │ 戻り値!=0 → 終了   │
                        │ ref空 → 終了       │
                        └─────────────────────┘
                                  │
                                  ▼
                        ┌─────────────────────┐
                        │ refs/heads/除去     │
                        └─────────────────────┘
                                  │
                                  ▼
                          ブランチ名出力
```

### 関連ファイル一覧

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