# バッチ設計書 34-make clean

## 概要

本ドキュメントは、mrubyプロジェクトにおけるMakeターゲット `make clean` のバッチ設計書である。MakefileからRakeを呼び出してビルド成果物を削除するラッパーコマンドについて記述する。

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

`make clean` は、Makefileで定義されたクリーンアップ用ターゲットであり、Rakeの `clean` タスクを呼び出して全ビルド成果物およびインストール済みアーティファクトを削除する。

**業務上の目的・背景**：ビルド環境をクリーンな状態にリセットするために使用される。ビルド設定の変更後やビルドの不整合が発生した場合に、ゼロからのリビルドを可能にする。また、ディスク容量の解放にも寄与する。

**バッチの実行タイミング**：開発者が手動で任意のタイミングで実行する。ビルド設定変更時、ビルドエラーのトラブルシューティング時、またはリリース前のクリーンビルドが必要な場合に使用される。

**主要な処理内容**：
1. Rakeコマンドの存在チェック（check_rake依存ターゲット）
2. `$(RAKE) clean` の実行
3. Rakefileのcleanタスクにより、各ターゲットのbuild_dirを `rm_rf` で削除
4. 各ターゲットのproductsを `rm_f` で削除
5. クリーンアップ完了メッセージの出力

**前後の処理との関連**：本タスクは独立して実行可能である。実行後は全ビルド成果物が削除されるため、再度 `make all` や `make test` の実行が必要になる。No.26 `rake deep_clean` はさらに広範囲の削除を行う上位互換のタスクである。

**影響範囲**：各ビルドターゲットのbuild_dirおよびproducts（バイナリ、ライブラリ等）が削除される。ソースコードには影響しない。

## バッチ種別

クリーンアップ処理（Rakeラッパー）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（開発者によるコマンド実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ruby | Rubyランタイムがインストールされていること |
| Rake | Rakeコマンドが利用可能であること（check_rakeで検証） |

### 実行可否判定

Makefileの `check_rake` ターゲットが先に実行され、Rakeコマンドの存在を確認する。存在しない場合はエラーメッセージを出力して終了する。ビルド成果物が存在しない場合でもエラーにはならない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAKE | Makefile変数 | No | rake | 使用するRakeコマンド |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Makefile | Make | ターゲット定義 |
| Rakefile | Ruby | cleanタスク定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 「Cleaned up target build directory」メッセージ |

### 出力ファイル仕様

本バッチはファイルを生成せず、既存のビルド成果物を削除する。

| 項目 | 内容 |
|-----|------|
| ファイル名 | N/A（削除処理のみ） |
| 出力先 | N/A |
| 文字コード | N/A |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. check_rake実行
   └─ rakeコマンドの存在確認
2. $(RAKE) clean実行
   └─ Rakefileのcleanタスクを呼び出し
3. 各ターゲットのbuild_dir削除
   └─ MRuby.each_targetで全ターゲットを走査し、rm_rfでbuild_dirを削除
4. 各ターゲットのproducts削除
   └─ rm_fでビルド成果物（バイナリ等）を削除
5. 完了メッセージ出力
   └─ 「Cleaned up target build directory」を標準出力に表示
```

### フローチャート

```mermaid
flowchart TD
    A[make clean 開始] --> B[check_rake: rakeコマンド存在確認]
    B --> C{rakeが存在?}
    C -->|なし| D[エラー出力・終了]
    C -->|あり| E["$(RAKE) clean 実行"]
    E --> F[各ターゲットのbuild_dirを削除]
    F --> G[各ターゲットのproductsを削除]
    G --> H["Cleaned up target build directory" 出力]
    H --> I[正常終了]
```

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

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

本バッチではデータベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

### テーブル別操作詳細

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コマンド未検出 | rakeコマンドがPATHに存在しない | Rubyおよびrake gemをインストールする |
| 非0終了 | 権限エラー | ビルドディレクトリの削除権限がない | 適切な権限で実行する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

権限エラーの場合は、適切な権限で再実行する。ビルドディレクトリが存在しない場合はエラーにならずスキップされる（`rm_rf` の特性）。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベーストランザクションなし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 全ビルドターゲット分のディレクトリとファイル |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 微小（ファイル削除のみ） |

## 排他制御

ビルド中やテスト実行中にcleanを実行するとファイル競合が発生する可能性がある。他のビルド・テストプロセスが実行中でないことを確認してから実行すること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 終了ログ | 処理完了時 | 「Cleaned up target build directory」 |
| エラーログ | エラー発生時 | エラー詳細メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 特に定めなし | 標準出力 |
| エラー件数 | 1件以上 | 標準エラー出力 |

## 備考

- `make clean` はMakefileで `clean: check_rake` と定義されており、`$(RAKE) clean` を実行する
- Rakefileのcleanタスクは `rm_rf` を使用するため、ディレクトリが存在しなくてもエラーにならない
- gem_clone_dirの削除は含まれない（`rake deep_clean` の範囲）
- Makefileのコメント `## clean all built and in-repo installed artifacts` がhelpターゲットで表示される
