# 機能設計書 89-ruby_prompt_info

## 概要

本ドキュメントは、現在のRubyバージョン情報をプロンプト表示用に取得する`ruby_prompt_info`関数の機能設計について記述する。

### 本機能の処理概要

ユーザーが使用しているRubyバージョン管理ツール（RVM、rbenv、chruby）を自動検出し、現在アクティブなRubyバージョン情報をプロンプト表示用にフォーマットして出力する統合関数である。

**業務上の目的・背景**：Ruby開発者は複数のRubyバージョンを切り替えながら作業することが多い。プロンプトに現在のRubyバージョンを表示することで、どのバージョンで作業しているかを常に把握でき、バージョン間違いによる問題を防止できる。また、RVM、rbenv、chrubyといった複数のバージョン管理ツールが存在するため、それらを統一的に扱う関数が必要となる。

**機能の利用シーン**：テーマがプロンプトを構築する際に、`$(ruby_prompt_info)`を呼び出してRubyバージョン情報を取得する。開発者はプロンプトを見るだけで現在のRubyバージョンを確認できる。

**主要な処理内容**：
1. rvm_prompt_info関数を呼び出し、成功すればその結果を使用
2. RVMが使用できない場合、rbenv_prompt_info関数を呼び出し
3. rbenvも使用できない場合、chruby_prompt_info関数を呼び出し
4. いずれかの結果を出力

**関連システム・外部連携**：RVM、rbenv、chrubyの各バージョン管理ツール。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面関連なし（関数） |

## 機能種別

プロンプト情報取得 / 統合関数

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- rvm_prompt_info関数の出力
- rbenv_prompt_info関数の出力
- chruby_prompt_info関数の出力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 標準出力 | 文字列 | フォーマットされたRubyバージョン情報 |

### 出力先

- 標準出力：プロンプト埋め込み用文字列

## 処理フロー

### 処理シーケンス

```
1. rvm_prompt_info呼び出し
   └─ 成功すればその結果を出力
2. rbenv_prompt_info呼び出し
   └─ RVMが失敗した場合、rbenvを試行
3. chruby_prompt_info呼び出し
   └─ rbenvも失敗した場合、chrubyを試行
4. 結果出力
   └─ いずれかの成功結果をechoで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[rvm_prompt_info呼び出し]
    B --> C{成功?}
    C -->|Yes| D[結果を出力]
    C -->|No| E[rbenv_prompt_info呼び出し]
    E --> F{成功?}
    F -->|Yes| D
    F -->|No| G[chruby_prompt_info呼び出し]
    G --> H{成功?}
    H -->|Yes| D
    H -->|No| I[空出力]
    D --> J[終了]
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-89-001 | 優先順位 | RVM > rbenv > chrubyの順で試行 | 常時 |
| BR-89-002 | フォールバック | 前のツールが失敗したら次を試行 | 各ツールの結果がfalseの場合 |
| BR-89-003 | ダミー関数 | プラグイン未読込時はダミー関数が使用される | プラグインが有効化されていない場合 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ツール不在 | RVM/rbenv/chrubyいずれも利用不可 | 空文字列を出力 |

### リトライ仕様

リトライは行わない。

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

トランザクション管理なし。

## パフォーマンス要件

- プロンプト表示のたびに呼び出されるため、高速に完了すること
- 通常数十ミリ秒以内で完了

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

- 外部コマンドの実行結果をそのまま出力するため、バージョン文字列の内容を信頼
- %文字のエスケープを行う（`:gs/%/%%`）

## 備考

- rvm_prompt_infoはlib/prompt_info_functions.zshで定義
- rbenv_prompt_info、chruby_prompt_infoはダミー関数として定義され、プラグイン読み込み時に実装される
- ZSH_THEME_RVM_PROMPT_OPTIONS変数でRVMオプションを制御

---

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

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

### 推奨読解順序

#### Step 1: 統合関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | prompt_info_functions.zsh | `lib/prompt_info_functions.zsh` | 43-45行目: ruby_prompt_info関数 |

**読解のコツ**: `||`はシェルの論理OR演算子。前のコマンドが失敗（return 1）した場合のみ次が実行される。

**主要処理フロー**:
- **43行目**: 関数定義
- **44行目**: `rvm_prompt_info || rbenv_prompt_info || chruby_prompt_info`の呼び出しチェーン
- 最初に成功した関数の出力がechoされる

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | prompt_info_functions.zsh | `lib/prompt_info_functions.zsh` | 30-36行目: rvm_prompt_info関数 |

**主要処理フロー**:
- **31行目**: rvm-promptの存在確認
- **32-34行目**: rvm-promptコマンド実行とバージョン取得
- **35行目**: テーマ変数でフォーマットして出力
- **38行目**: ZSH_THEME_RVM_PROMPT_OPTIONSのデフォルト値設定

#### Step 3: ダミー関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | prompt_info_functions.zsh | `lib/prompt_info_functions.zsh` | 13-26行目: ダミー関数定義 |

**主要処理フロー**:
- **13-25行目**: 複数のダミー関数を一括定義
- **25行目**: `return 1`でfalseを返す（次のツールを試行させる）
- プラグイン読み込み時に実際の実装で上書きされる

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

```
ruby_prompt_info()  ← 本機能
    │
    ├─ rvm_prompt_info()
    │      └─ ~/.rvm/bin/rvm-prompt
    │
    ├─ rbenv_prompt_info()  [ダミー or プラグイン]
    │      └─ rbenv version-name
    │
    └─ chruby_prompt_info()  [ダミー or プラグイン]
           └─ chruby コマンド
```

### データフロー図

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

rvm-prompt出力 ──────────┐
                         │
rbenv version-name ──────┼─▶ ruby_prompt_info() ──────▶ プロンプト文字列
                         │         │
chruby出力 ──────────────┘         │
                                   └─▶ ZSH_THEME_RUBY_PROMPT_PREFIX
                                       + バージョン
                                       + ZSH_THEME_RUBY_PROMPT_SUFFIX
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| prompt_info_functions.zsh | `lib/prompt_info_functions.zsh` | ソース | プロンプト情報関数群 |
| rvm.plugin.zsh | `plugins/rvm/rvm.plugin.zsh` | プラグイン | RVM統合（オプション） |
| rbenv.plugin.zsh | `plugins/rbenv/rbenv.plugin.zsh` | プラグイン | rbenv統合（オプション） |
| chruby.plugin.zsh | `plugins/chruby/chruby.plugin.zsh` | プラグイン | chruby統合（オプション） |
