# バッチ設計書 25-rake clean

## 概要

本ドキュメントは、mrubyプロジェクトにおける `rake clean` タスクのバッチ設計書である。全ビルドターゲットのビルド成果物とインストール済みアーティファクトを削除するクリーンアップ処理を定義する。

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

`rake clean` は、mrubyの全ビルドターゲットについて、ビルドディレクトリとプロダクトファイルを削除するRakeタスクである。ビルド環境をクリーンな状態に戻す際に使用する。

**業務上の目的・背景**：ビルド環境に問題が発生した場合やビルド構成を変更した場合に、古いビルド成果物を完全に削除して再ビルドする必要がある。本タスクはビルドディレクトリを削除することで、クリーンな状態からの再ビルドを可能にする。

**バッチの実行タイミング**：手動実行。ビルド環境のリセットが必要な場合に随時実行する。

**主要な処理内容**：
1. `MRuby.each_target` で全ビルドターゲットを列挙
2. 各ターゲットの `build_dir`（例: `build/host/`）を再帰的に削除
3. 各ターゲットの `products` ファイルを削除
4. クリーンアップ完了メッセージを出力

**前後の処理との関連**：前提となるバッチはない。`rake deep_clean` は本タスクを含むより広範なクリーンアップを行う。後続で `rake all` を実行すれば再ビルドされる。

**影響範囲**：`build/` ディレクトリ配下の全ビルドターゲットのディレクトリが削除される。リポジトリのソースコードやbinディレクトリには影響しない。

## バッチ種別

クリーンアップ（ビルド成果物削除）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（`rake clean` コマンド実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ruby環境 | Rakeが実行可能なRuby環境がセットアップされていること |

### 実行可否判定

特別な前提条件はない。ビルド成果物が存在しなくても実行可能（何も削除されないだけ）。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| MRUBY_CONFIG | 環境変数（文字列） | No | デフォルトビルド設定 | 使用するビルド構成ファイルのパス（ターゲット一覧の決定に使用） |
| MRUBY_BUILD_DIR | 環境変数（文字列） | No | `{MRUBY_ROOT}/build` | ビルドディレクトリのルートパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| build/{target}/ | ディレクトリ | 各ターゲットのビルドディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| N/A | N/A | 出力はなし（削除操作のみ） |

### 出力ファイル仕様

出力ファイルはなし。

## 処理フロー

### 処理シーケンス

```
1. rake clean タスク開始
2. MRuby.each_target で全ターゲットを列挙
   └─ 各ターゲットの build_dir を rm_rf で再帰削除
   └─ 各ターゲットの products ファイルを rm_f で削除
3. "Cleaned up target build directory" メッセージを出力
4. rake clean タスク完了
```

### フローチャート

```mermaid
flowchart TD
    A[rake clean 開始] --> B[全ターゲット列挙]
    B --> C[build_dir を再帰削除]
    C --> D[products ファイルを削除]
    D --> E{次のターゲット?}
    E -->|Yes| C
    E -->|No| F[完了メッセージ出力]
    F --> G[rake clean 完了]
```

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

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

本バッチはデータベース操作を行わない。ファイルシステム上の削除操作のみ。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | 権限エラー | ビルドディレクトリの削除権限がない | 適切な権限で再実行 |
| N/A | ファイルロック | ファイルが他のプロセスで使用中 | 他のプロセスを停止してから再実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動で再実行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

`rm_rf` は可能な限り削除を行うため、部分的な失敗が発生しても他のターゲットの削除は継続される。手動で残存ディレクトリを削除することも可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし |
| コミットタイミング | 各ディレクトリ・ファイル削除完了時 |
| ロールバック条件 | なし（削除操作は不可逆） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ターゲット数分のディレクトリ |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | Ruby プロセスの標準的なメモリ使用量 |

## 排他制御

ビルド中やテスト中に実行すると競合が発生する可能性がある。他のRakeタスクの実行中は使用しないこと。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | 処理完了時 | `Cleaned up target build directory` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行タスクのため監視対象外） |

## 備考

- `rm_rf` を使用するため、ビルドディレクトリの内容は完全に削除される（復旧不可）
- `rm_f` で products（通常はリポジトリルートにシンボリックリンクされたバイナリ等）も削除される
- gem の clone ディレクトリ（`build/repos/`）は削除されない（`deep_clean` で削除される）
- リポジトリルートの `bin/` ディレクトリは削除されない（`deep_clean` で削除される）
