# バッチ設計書 26-rake deep_clean

## 概要

本ドキュメントは、mrubyプロジェクトにおける `rake deep_clean` タスクのバッチ設計書である。全ビルド成果物に加えて、gem clone ディレクトリ、`bin/` ディレクトリ、`build/` ディレクトリ全体、および生成済みドキュメントを削除する完全クリーンアップ処理を定義する。

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

`rake deep_clean` は、`rake clean` のクリーンアップに加えて、gem の clone ディレクトリ、リポジトリルートの `bin/` ディレクトリ、`build/` ディレクトリ全体、および生成済みドキュメントを削除するRakeタスクである。プロジェクトをソースコードのみの初期状態に戻す。

**業務上の目的・背景**：ビルド環境を完全にリセットしたい場合に使用する。`rake clean` ではgem cloneやリポジトリルートのバイナリが残るため、より徹底したクリーンアップが必要な場面（例：gem構成の変更、ビルドシステムの問題解決、CI環境のリセット）で本タスクを使用する。

**バッチの実行タイミング**：手動実行。完全なビルド環境のリセットが必要な場合に随時実行する。docker-compose経由のテスト実行時にも自動的に呼び出される。

**主要な処理内容**：
1. `clean` タスクを実行（ビルドディレクトリとプロダクトの削除）
2. `doc:clean` タスクを実行（生成済みドキュメントの削除）
3. 各ターゲットの `gem_clone_dir` を再帰的に削除
4. リポジトリルートの `bin/` ディレクトリを再帰的に削除
5. リポジトリルートの `build/` ディレクトリを再帰的に削除

**前後の処理との関連**：`clean` および `doc:clean` タスクに依存する。docker-compose.yml では `rake deep_clean` の後に `rake -m test:run:serial` が実行される。

**影響範囲**：`build/` ディレクトリ全体、`bin/` ディレクトリ、`doc/api/`、`.yardoc/`、`doc/capi/` が削除される。ソースコードやドキュメントの元ファイルには影響しない。

## バッチ種別

クリーンアップ（完全削除）

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

特別な前提条件はない。削除対象が存在しなくても実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| MRUBY_CONFIG | 環境変数（文字列） | No | デフォルトビルド設定 | 使用するビルド構成ファイルのパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| build/ | ディレクトリ | ビルドディレクトリ全体 |
| bin/ | ディレクトリ | リポジトリルートのバイナリディレクトリ |
| build/repos/{target}/ | ディレクトリ | 各ターゲットのgem cloneディレクトリ |
| doc/api/, .yardoc/, doc/capi/ | ディレクトリ | 生成済みドキュメントディレクトリ |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

出力ファイルはなし。

## 処理フロー

### 処理シーケンス

```
1. rake deep_clean タスク開始
   └─ 依存タスク: clean, doc:clean
2. clean タスク実行
   └─ 全ターゲットの build_dir を再帰削除
   └─ 全ターゲットの products ファイルを削除
3. doc:clean タスク実行
   └─ doc/api, .yardoc, doc/capi を削除
4. 各ターゲットの gem_clone_dir を再帰削除
5. {MRUBY_ROOT}/bin ディレクトリを再帰削除
6. {MRUBY_ROOT}/build ディレクトリを再帰削除
7. "Cleaned up mrbgems build directory" メッセージを出力
8. rake deep_clean タスク完了
```

### フローチャート

```mermaid
flowchart TD
    A[rake deep_clean 開始] --> B[clean タスク実行]
    B --> C[doc:clean タスク実行]
    C --> D[全ターゲット列挙]
    D --> E[gem_clone_dir を再帰削除]
    E --> F{次のターゲット?}
    F -->|Yes| E
    F -->|No| G[bin/ ディレクトリを再帰削除]
    G --> H[build/ ディレクトリを再帰削除]
    H --> I[完了メッセージ出力]
    I --> J[rake deep_clean 完了]
```

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

`rm_rf` は可能な限り削除を行う。手動で残存ディレクトリを削除することも可能。

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ（clean） | clean完了時 | `Cleaned up target build directory` |
| 完了ログ（deep_clean） | deep_clean完了時 | `Cleaned up mrbgems build directory` |

## 監視・アラート

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

## 備考

- `deep_clean` は `clean` と `doc:clean` に依存し、それらの処理を含む
- `clean` では削除されない `gem_clone_dir`（`build/repos/{target}/`）を追加で削除する
- リポジトリルートの `bin/` と `build/` ディレクトリも完全に削除される
- docker-compose.yml では `rake deep_clean && rake -m test:run:serial` として使用されている
- gem clone ディレクトリの削除により、次回ビルド時にgemが再度cloneされる
