# バッチ設計書 16-app:template

## 概要

本ドキュメントは、Railsフレームワークに含まれるRakeタスク `app:template` の設計仕様を記載したものです。このタスクは指定されたRailsアプリケーションテンプレートを既存のアプリケーションに適用します。

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

このバッチは、LOCATION環境変数で指定されたRailsテンプレートファイル（ローカルパスまたはURL）を既存のRailsアプリケーションに適用します。テンプレートはRubyのDSLで記述され、gem追加、ファイル生成、設定変更などを自動化できます。

**業務上の目的・背景**：Railsアプリケーションの構成を標準化したり、共通の設定やgemを複数のプロジェクトに適用する場合があります。このタスクは、テンプレートファイルを使用して既存のアプリケーションにカスタマイズを適用することで、手動設定の手間を削減し、設定の一貫性を保証します。CI/CDパイプラインや社内の標準構成の適用、サードパーティのスターターキットの導入などに活用されます。

**バッチの実行タイミング**：アプリケーションの初期設定後や、追加機能の導入時に手動で実行されます。定期実行ではなく、必要に応じてオンデマンドで使用されます。

**主要な処理内容**：
1. LOCATION環境変数からテンプレートのパスまたはURLを取得
2. Rails::Generators::AppGeneratorを使用してテンプレートを適用
3. テンプレート内のDSLコマンドを順次実行（gem追加、ファイル生成等）

**前後の処理との関連**：このタスクは独立して実行されますが、テンプレート内で他のRakeタスクや生成コマンドを呼び出すことがあります。

**影響範囲**：テンプレートの内容に依存しますが、Gemfile、設定ファイル、アプリケーションコードなど広範囲に影響する可能性があります。

## バッチ種別

構成管理 / テンプレート適用

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bin/rails app:template LOCATION=...） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション | 有効なRailsプロジェクト内で実行すること |
| LOCATION環境変数 | テンプレートのパスまたはURLが指定されていること |
| テンプレートファイル | 指定されたパス/URLにテンプレートが存在すること |

### 実行可否判定

LOCATION環境変数が設定されていない場合、エラーメッセージを表示してraiseします。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| LOCATION | String | Yes | なし | テンプレートのローカルパスまたはURL |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| テンプレートファイル | Ruby | Railsテンプレート（.rbファイル） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| アプリケーションディレクトリ | 各種ファイル | テンプレートにより生成・変更されたファイル |
| 標準出力（STDOUT） | テキスト | 実行進捗・結果 |

### 出力ファイル仕様

テンプレートの内容により異なります。一般的な出力例：
- Gemfileへのgem追加
- config/ファイルの変更
- app/配下のファイル生成
- db/migrate/へのマイグレーションファイル追加

## 処理フロー

### 処理シーケンス

```
1. Rails環境のロード（:environment依存タスク）
   └─ アプリケーション初期化処理を実行
2. LOCATION環境変数の取得
   └─ 未設定の場合はraiseでエラー
3. Rails::Generatorsのrequire
   └─ rails/generators と rails/generators/rails/app/app_generator をロード
4. テンプレートの適用
   └─ Rails::Generators::AppGenerator.apply_rails_template を呼び出し
   └─ テンプレート内のDSLコマンドを順次実行
5. 処理完了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Rails環境ロード]
    B --> C{LOCATION設定あり?}
    C -->|いいえ| D[エラーメッセージ表示]
    D --> E[raise終了]
    C -->|はい| F[Rails::Generatorsをrequire]
    F --> G[AppGenerator.apply_rails_template呼び出し]
    G --> H[テンプレートDSL実行]
    H --> I[バッチ正常終了]
```

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

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

タスク自体はデータベース操作を行いませんが、テンプレート内でマイグレーションを実行する場合があります。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| raise | 引数エラー | LOCATIONが未設定 | LOCATION環境変数を設定 |
| raise | ファイルエラー | テンプレートが見つからない | パス/URLを確認 |
| raise | 構文エラー | テンプレートの構文エラー | テンプレートを修正 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. LOCATIONのパス/URLが正しいか確認
3. テンプレートファイルにアクセス可能か確認
4. テンプレートの構文を確認
5. 必要に応じてgitで変更を取り消し

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし（手動でgit resetが必要） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テンプレートの内容に依存 |
| 目標処理時間 | テンプレートの内容に依存 |
| メモリ使用量上限 | 通常のRails起動メモリ内 |

## 排他制御

同時実行は避けるべきです。テンプレートによるファイル変更が競合する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | 各DSLコマンドの実行結果 |

## 監視・アラート

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

## 備考

- テンプレートで使用可能な主なDSLメソッド：
  - `gem`: Gemfileにgemを追加
  - `gem_group`: グループ付きでgemを追加
  - `generate`: Rails generatorを実行
  - `rake`: Rakeタスクを実行
  - `initializer`: initializer ファイルを生成
  - `environment`: config/application.rbに設定を追加
  - `git`: gitコマンドを実行
  - `route`: config/routes.rbにルートを追加
  - `copy_file`, `create_file`: ファイル操作
- テンプレートはローカルファイルパスまたはURLで指定可能
- URL指定の場合、HTTPSでのダウンロードがサポートされます
- テンプレート適用前にgit commitしておくことを推奨します
