# 機能設計書 50-Ruby

## 概要

本ドキュメントは、space-vimにおけるRuby言語サポート機能の設計仕様を定義する。本機能はvim-rubyプラグインを統合し、Rubyファイル編集時の構文ハイライト、インデント、オムニ補完機能を提供する。

### 本機能の処理概要

本機能は、Rubyファイル（.rb）の編集時に、Ruby言語に最適化された編集支援機能を提供する。vim-rubyプラグインにより、構文ハイライト、適切なインデント、オムニ補完を実現する。

**業務上の目的・背景**：RubyはWebアプリケーション開発（Ruby on Rails）、スクリプト作成、自動化ツール開発で広く使用されているプログラミング言語である。Vim上でのRuby開発を効率化し、言語固有の構文ハイライトとインデントを提供することで、開発生産性の向上を実現する。

**機能の利用シーン**：
- Rubyスクリプトの作成・編集
- Ruby on Railsアプリケーション開発
- Rubyコードの構文ハイライト表示
- 適切なインデント自動設定

**主要な処理内容**：
1. Rubyファイルタイプ検出時のvim-ruby読み込み
2. Ruby構文ハイライトの適用
3. Rubyインデントルールの適用
4. オムニ補完機能の提供

**関連システム・外部連携**：
- vim-ruby/vim-ruby プラグイン
- Ruby インタプリタ

**権限による制御**：特になし（全ユーザー共通機能）

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 8 | 補完ポップアップ | 参照画面 | Rubyコードの補完候補表示 |

## 機能種別

言語サポート / 構文ハイライト / インデント / 補完

## 入力仕様

### 入力パラメータ

本機能には特別な設定パラメータはない（config.vimは空）。

### 入力データソース

- Rubyソースファイル（.rb）
- ERBテンプレートファイル（.erb）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 構文ハイライト | Highlight | Ruby構文の色分け表示 |
| インデント | Number | Ruby構文に応じた適切なインデントレベル |
| 補完候補 | List | Ruby識別子の補完候補 |

### 出力先

- エディタバッファ（構文ハイライト、インデント）
- 補完ポップアップウィンドウ

## 処理フロー

### 処理シーケンス

```
1. Rubyファイルオープン
   └─ ファイルタイプ検出（ruby）

2. vim-ruby プラグイン読み込み
   └─ { 'for': 'ruby' } による遅延読み込み

3. 構文ハイライト適用
   └─ Ruby構文のカラーリング

4. インデントルール適用
   └─ Rubyインデントの自動設定

5. オムニ補完利用可能
   └─ Ctrl-X Ctrl-O で補完
```

### フローチャート

```mermaid
flowchart TD
    A[Rubyファイルオープン] --> B[ファイルタイプ検出]
    B --> C[vim-ruby読み込み]
    C --> D[構文ハイライト適用]
    D --> E[インデントルール適用]
    E --> F[オムニ補完有効]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-50-01 | ファイルタイプ読み込み | rubyファイルタイプでプラグインを読み込み | ファイルオープン時 |

### 計算ロジック

該当なし

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

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Ruby未インストール | オムニ補完でRubyが必要 | Rubyインストール案内 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- ファイルタイプ検出時のみプラグインを読み込み（遅延読み込み）

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

- 外部ツール（Ruby）はローカル環境のものを使用

## 備考

- vim-rubyはVimに同梱されているが、最新版を使用するためプラグインとして登録
- Rails開発ではvim-rails等の追加プラグインとの併用を推奨

---

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

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

### 推奨読解順序

#### Step 1: プラグイン登録を理解する

vim-rubyプラグインの登録方法を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | packages.vim | `layers/+lang/ruby/packages.vim` | プラグイン登録 |

**読解のコツ**: シンプルな1行のみで、rubyファイルタイプでの遅延読み込みを設定。

**主要処理フロー**:
1. **1行目**: `MP 'vim-ruby/vim-ruby', { 'for': 'ruby' }` - rubyファイルタイプで読み込み

#### Step 2: 設定を理解する

config.vimは空のため、vim-rubyのデフォルト設定がそのまま適用される。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | config.vim | `layers/+lang/ruby/config.vim` | 追加設定（空ファイル） |

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

```
Rubyファイルオープン
    │
    └─ layers/+lang/ruby/packages.vim
           └─ vim-ruby 登録 { 'for': 'ruby' }
                  │
                  ├─ 構文ハイライト適用
                  ├─ インデントルール適用
                  └─ オムニ補完有効化
```

### データフロー図

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

Rubyソースコード ───▶ vim-ruby 読み込み ─────▶ ハイライト表示
     │                      │
     │                      ├────────────────▶ インデント適用
     │                      │
     └─────────────────▶ Ctrl-X Ctrl-O ────▶ 補完候補表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| packages.vim | `layers/+lang/ruby/packages.vim` | 設定 | プラグイン登録 |
| config.vim | `layers/+lang/ruby/config.vim` | 設定 | 追加設定（空ファイル） |
