# バッチ設計書 15-doc:test

## 概要

本ドキュメントは、CoffeeScriptプロジェクトにおける`doc:test`タスクの設計書です。このバッチは、ブラウザベースのテストページをビルドし、`test/`配下のテストファイルをHTML形式で出力するツールです。

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

このバッチは、CoffeeScriptのテストスイートをブラウザで実行できる形式のHTMLページとして生成します。`test/`ディレクトリ配下のCoffeeScriptテストファイルを読み込み、`<script>`タグに埋め込んだHTMLファイルを出力します。このHTMLファイルをブラウザで開くことで、ブラウザ環境でのテスト実行が可能になります。

**業務上の目的・背景**：CoffeeScriptコンパイラはブラウザ環境でも動作するため、ブラウザでのテストが必要です。このバッチを使用することで、Node.js環境だけでなくブラウザ環境でもテストを実行でき、ブラウザ固有の問題を検出できます。特に、ブラウザ版コンパイラ（`build:browser`で生成）の動作検証に使用されます。

**バッチの実行タイミング**：手動実行、または`release`タスクの一部として実行されます。ブラウザテストの準備時に実行します。

**主要な処理内容**：
1. `documentation/site/test.html`テンプレートを読み込み
2. `test/support/helpers.coffee`からテストヘルパーを読み込み
3. `test/`ディレクトリ内の全テストファイルをスキャン
4. 各テストファイルを`<script>`タグとして埋め込み
5. テンプレートを展開してHTMLを生成
6. `docs/vX/test.html`に出力

**前後の処理との関連**：`release`タスクおよび`build:browser:full`タスクから呼び出されます。`test:browser`タスクで生成されたテストページが使用されます。

**影響範囲**：`docs/vX/test.html`が生成されます。

## バッチ種別

テスト生成 / ブラウザテストページビルド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリース時・テスト更新時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動/releaseタスク/build:browser:fullタスク |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| 依存パッケージ | `npm install`が完了していること |
| テストファイル | test/配下にテストファイルが存在すること |
| テンプレート | documentation/site/test.htmlが存在すること |

### 実行可否判定

- `documentation/site/test.html`が存在すること
- `test/`ディレクトリが存在すること
- `test/support/helpers.coffee`が存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数なし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| documentation/site/test.html | HTML(テンプレート) | テストページテンプレート |
| test/support/helpers.coffee | CoffeeScript | テストヘルパー関数 |
| test/*.coffee | CoffeeScript | テストファイル |
| test/*.litcoffee | Literate CoffeeScript | 文芸的テストファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| docs/vX/test.html | HTML | ブラウザテストページ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | test.html |
| 出力先 | docs/vX/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. 定数設定
   └─ testFile、testsSourceFolder、outputFolderを設定
2. テストヘルパー読み込み
   └─ test/support/helpers.coffeeを読み込み、exports.を@に置換
3. testsInScriptBlocks関数実行
   └─ test/配下のファイルをスキャン
4. ファイルタイプ判定
   └─ .coffee → coffeescript、.litcoffee → literate-coffeescript
5. scriptタグ生成
   └─ 各テストファイルを<script>タグに埋め込み
6. テンプレート展開
   └─ testHelpersとtestsを展開
7. HTML出力
   └─ docs/vX/test.htmlに出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[定数設定]
    B --> C[テストヘルパー読み込み]
    C --> D[test/ディレクトリスキャン]
    D --> E{各ファイル処理}
    E --> F{.coffee?}
    F -->|はい| G[type=coffeescript]
    F -->|いいえ| H{.litcoffee?}
    H -->|はい| I[type=literate-coffeescript]
    H -->|いいえ| E
    G --> J[scriptタグ生成]
    I --> J
    J --> E
    E -->|完了| K[テンプレート展開]
    K --> L[HTML出力]
    L --> M[バッチ終了]
```

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

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

該当なし（ファイルシステム操作のみ）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル読み込みエラー | テンプレートまたはテストファイルが存在しない | ファイルパスを確認 |
| - | テンプレートエラー | テンプレート構文エラー | テンプレートを修正 |

### リトライ仕様

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

### 障害時対応

- ファイル読み込みエラー時は例外がスローされる
- テストファイルが見つからない場合は空のテストページが生成される

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テストファイル数十個 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行：可能だが推奨しない
- ロック仕様：なし

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | HTML出力完了時 | "compiled documentation/site/test.html → docs/vX/test.html" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- スクリプトタイプは`text/x-coffeescript`または`text/x-literate-coffeescript`に設定
  - `text/x-`プレフィックスはブラウザコンパイラによる自動実行を防止
- 各テストファイルはファイル名（拡張子なし）をIDとして設定
- テストヘルパーの`exports.`は`@`に置換されてブラウザ環境に適合
- ファイル一覧はソートされて処理される
