# 機能設計書 44-toplevel拡張

## 概要

本ドキュメントは、mruby-toplevel-ext gemが提供するトップレベルオブジェクト（main）への拡張メソッドの機能設計を記述する。トップレベルでのincludeメソッドをサポートする。

### 本機能の処理概要

mruby-toplevel-ext gemは、mrubyのトップレベルオブジェクト（main）にincludeメソッドを追加する。全てRuby(mrblib/toplevel.rb)で実装されている。トップレベルでincludeを呼び出すと、指定されたモジュールがObjectクラスにincludeされ、結果として全オブジェクトからそのモジュールのメソッドが利用可能になる。

**業務上の目的・背景**：CRubyでは、トップレベルでincludeを呼ぶことで、モジュールのメソッドをグローバルに利用可能にできる。mrubyでもこの機能を提供することで、スクリプト作成時の利便性を向上させる。特に短いスクリプトやDSL的な使い方で有用である。

**機能の利用シーン**：トップレベルでモジュールをincludeし、そのモジュールのメソッドをグローバルに使用する場合（例：`include Greeting`とすることで全オブジェクトでhelloメソッドが使えるようになる）。

**主要な処理内容**：
1. トップレベルのincludeメソッド - 指定モジュールをObjectクラスにincludeする

**関連システム・外部連携**：なし。mrubyコアのモジュールinclude機能に依存する。

**権限による制御**：includeメソッドはプライベートメソッドとして定義される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能はライブラリ機能であり、画面との関連はない |

## 機能種別

ライブラリ拡張（トップレベルオブジェクトへのメソッド追加）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| modules | Module | Yes | includeするモジュール（複数指定可） | Moduleオブジェクトであること |

### 入力データソース

メソッド呼び出し時の引数

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| include戻り値 | Object | self（トップレベルオブジェクト） |

### 出力先

メソッドの戻り値として呼び出し元に返却。副作用としてObjectクラスにモジュールがincludeされる。

## 処理フロー

### 処理シーケンス

```
1. トップレベルでinclude(modules)を呼び出す
   └─ Object.include(*modules)に委譲
       └─ Module.append_featuresが各モジュールに対して逆順で呼ばれる
```

### フローチャート

```mermaid
flowchart TD
    A[include Greeting] --> B[mainのシングルトンクラスのincludeメソッド呼び出し]
    B --> C[Object.include Greeting に委譲]
    C --> D[GreetingモジュールがObjectの継承チェーンに追加]
    D --> E[全オブジェクトからGreetingのメソッドが利用可能]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-44-01 | Objectへの委譲 | トップレベルincludeはObject.includeへ委譲される | トップレベルinclude呼び出し時 |
| BR-44-02 | プライベートメソッド | includeはmainのシングルトンクラスのプライベートメソッドとして定義 | 常時 |
| BR-44-03 | グローバル影響 | Objectにincludeされるため全オブジェクトに影響する | 常時 |

### 計算ロジック

特になし

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | TypeError | 非Moduleオブジェクトをincludeしようとした場合 | Moduleオブジェクトを渡す |

### リトライ仕様

リトライは不要

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

該当なし

## パフォーマンス要件

include操作はクラス継承チェーンの変更を伴うため、実行時に若干のオーバーヘッドがある。ただし通常は初期化時に1回のみ呼ばれる。

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

トップレベルincludeはObjectクラスを変更するため、全オブジェクトに影響を与える。信頼されないモジュールのincludeには注意が必要。

## 備考

- 非常に小さなgemであり、Ruby実装のみ（Cコードなし）
- `class <<self`でmainのシングルトンクラスにメソッドを定義している
- CRubyとの互換性を保つための実装

---

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

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

### 推奨読解順序

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

独自のデータ構造はない。mrubyコアのモジュールinclude機構を使用する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | mrbgem.rake | `mrbgems/mruby-toplevel-ext/mrbgem.rake` | gem定義。依存関係なし |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | toplevel.rb | `mrbgems/mruby-toplevel-ext/mrblib/toplevel.rb` | 全実装コード |

**主要処理フロー**:
1. **1行目**: `class <<self` - mainオブジェクトのシングルトンクラスを開く
2. **2行目**: `private` - 以降のメソッドをプライベートにする
3. **21-23行目**: `include`メソッド定義 - `Object.include(*modules)`に委譲
4. **24行目**: `end` - シングルトンクラス定義を閉じる

**読解のコツ**: `class <<self`はRubyの構文で、selfのシングルトンクラス（特異クラス）を開く。トップレベルでのselfはmainオブジェクトであるため、mainの特異クラスにメソッドを追加していることになる。

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

```
main.include(*modules)
    |
    +-- Object.include(*modules)
            |
            +-- Module#append_features (各モジュールに対して逆順)
```

### データフロー図

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

Module          --> main.include(Module)       --> Object.include(Module)
                                                   --> 全オブジェクトのメソッドテーブル更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| toplevel.rb | `mrbgems/mruby-toplevel-ext/mrblib/toplevel.rb` | ソース | includeメソッドのRuby実装 |
| mrbgem.rake | `mrbgems/mruby-toplevel-ext/mrbgem.rake` | 設定 | gem定義ファイル |
| toplevel.rb | `mrbgems/mruby-toplevel-ext/test/toplevel.rb` | テスト | includeメソッドのテスト |
