# バッチ設計書 7-rake generate_active_gems_txt

## 概要

本ドキュメントは、有効なgemsのテキストファイル（`active_gems.txt`）を生成する `rake generate_active_gems_txt` タスクの設計仕様を記述する。

### 本バッチの処理概要

`rake generate_active_gems_txt` は、ビルド設定で有効になっている全gemの名前を一覧としてテキストファイルに出力するタスクである。このファイルは `gem_init.c` の生成トリガーとして使用される。

**業務上の目的・背景**：mrubyのビルドでは、有効なgemの組み合わせが変更された場合に `gem_init.c` の再生成が必要になる。`active_gems.txt` はこの変更検出のためのトリガーファイルとして機能する。gemの追加・削除が行われた場合にのみ `gem_init.c` が再生成されるよう、現在のgem一覧をファイルに書き出して差分検出を行う仕組みである。

**バッチの実行タイミング**：`gem_init.c` の依存関係として `active_gems.txt` が指定されており、`active_gems.txt` はさらに `:generate_active_gems_txt` タスクに依存している。Rakeの依存関係解決時に自動実行される。タスクの `timestamp` が `Time.at(0)` に設定されているため、毎回実行される。

**主要な処理内容**：
1. 有効なgemを名前でソートする
2. gem名を改行区切りの文字列に結合する
3. 既存の `active_gems.txt` が存在しない場合、または内容が異なる場合のみファイルを書き出す

**前後の処理との関連**：本タスクの出力は mrbgems.rake（No.6）の `gem_init.c` 生成タスクの依存関係として使用される。gemの一覧に変更があった場合に `gem_init.c` の再生成をトリガーする。

**影響範囲**：`build/{target}/mrbgems/active_gems.txt` のみに影響する。

## バッチ種別

ファイル生成処理（変更検出トリガー）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド時に毎回実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Rakeの依存関係解決により自動実行（`timestamp` が `Time.at(0)` のため毎回実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ビルド設定 | MRuby.targets が構成済みであること |
| gems | 有効なgemリストが取得可能であること |

### 実行可否判定

`timestamp` が `Time.at(0)` に設定されているため、常に「古い」とみなされ毎回実行される。ただし、ファイルの書き出しは既存ファイルの内容と比較して差分がある場合のみ行われる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | ビルド設定のgems構成から自動決定 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| gems | Ruby オブジェクト | ビルド設定で有効な全gemのコレクション |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/{target}/mrbgems/active_gems.txt | テキストファイル | 有効なgem名の一覧（1行1gem、名前順ソート） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | active_gems.txt |
| 出力先 | `build/{target}/mrbgems/` |
| 文字コード | UTF-8 |
| 区切り文字 | 改行（1行1gem名） |

## 処理フロー

### 処理シーケンス

```
1. timestamp を Time.at(0) に設定
   └─ 毎回実行されるようにする
2. 有効なgemリストを名前でソート
   └─ gems.sort_by(&:name)
3. gem名を改行区切り文字列に結合
   └─ inject(+""){|s, g| s << "#{g.name}\n"}
4. 差分チェック
   └─ ファイルが存在しない、または内容が異なる場合
5. ファイル書き出し
   └─ File.write(active_gems_txt, active_gems) （差分がある場合のみ）
```

### フローチャート

```mermaid
flowchart TD
    A[generate_active_gems_txt 開始] --> B[有効なgemをソート]
    B --> C[gem名を改行区切りで結合]
    C --> D{active_gems.txt が存在する?}
    D -->|いいえ| E[ディレクトリ作成]
    E --> F[ファイル書き出し]
    D -->|はい| G{内容に差分あり?}
    G -->|はい| F
    G -->|いいえ| H[スキップ]
    F --> I[generate_active_gems_txt 終了]
    H --> I
```

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

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

本バッチではデータベース操作は発生しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ディレクトリ作成エラー | 出力ディレクトリの作成失敗 | ファイルシステムの権限を確認 |
| - | ファイル書き込みエラー | ファイルの書き込み失敗 | ディスク容量と権限を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

`rake clean` を実行して再ビルドする。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 有効なgemの数（通常数十件） |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 最小（テキスト処理のみ） |

## 排他制御

同一ビルドターゲットに対する同時実行は想定されていない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 明示的なログ出力はない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプラインの通知設定に依存 |

## 備考

- `def t.timestamp; Time.at(0) end` により、このタスクのタイムスタンプは常に最古（1970-01-01 00:00:00 UTC）となる。これにより、Rakeの依存関係チェックにおいて常に「更新が必要」と判断され、毎回実行される。
- ファイルの書き出しは差分がある場合のみ行われるため、不要な `gem_init.c` の再生成を防止している。
- `desc` が付与されているため `rake -T` の一覧に表示される。
- gem名はアルファベット順にソートされるため、gemの追加順序の違いによる無意味な差分は発生しない。
