# バッチ設計書 17-app:templates:copy

## 概要

本ドキュメントは、Railsフレームワークに含まれるRakeタスク `app:templates:copy` の設計仕様を記載したものです。このタスクはRailsのデフォルトジェネレーターテンプレートをアプリケーションディレクトリにコピーし、カスタマイズ可能にします。

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

このバッチは、Railsが提供するデフォルトのジェネレーターテンプレート（ERB、controller、mailer、scaffold等）をアプリケーションの`lib/templates`ディレクトリにコピーします。コピーされたテンプレートはローカルでカスタマイズでき、以降のジェネレーター実行時にカスタマイズ版が使用されます。

**業務上の目的・背景**：Railsのscaffoldやコントローラージェネレーターが生成するコードのスタイルを企業やプロジェクトの標準に合わせたい場合があります。例えば、生成されるビューにBootstrapクラスを追加したり、コントローラーに共通のbefore_actionを含めたりしたい場合です。このタスクを使用することで、デフォルトテンプレートをローカルにコピーし、自由にカスタマイズできるようになります。

**バッチの実行タイミング**：プロジェクト初期設定時やジェネレーターのカスタマイズが必要になった時に手動で実行されます。通常は一度だけ実行し、以降はコピーされたテンプレートを編集します。

**主要な処理内容**：
1. `lib/templates`ディレクトリの作成
2. ERB関連テンプレート（controller, mailer, scaffold）のコピー
3. Rails関連テンプレート（controller, helper, scaffold_controller）のコピー
4. 既存ファイルがある場合は上書き

**前後の処理との関連**：このタスクは独立して実行されます。コピー後、`rails generate scaffold`などを実行するとコピーされたテンプレートが使用されます。

**影響範囲**：`lib/templates`ディレクトリへのファイルコピーのみです。既存のアプリケーションコードには影響しません。

## バッチ種別

構成管理 / テンプレートコピー

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行、通常一度のみ） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bin/rails app:templates:copy） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション | 有効なRailsプロジェクト内で実行すること |
| 書き込み権限 | lib/ディレクトリへの書き込み権限があること |

### 実行可否判定

特別な判定ロジックはなく、常に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | このタスクはパラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Rails generators/erb | ERBテンプレート | ERBジェネレーター用テンプレート |
| Rails generators/rails | Rubyテンプレート | Railsジェネレーター用テンプレート |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| lib/templates/erb/ | ERBファイル | ERBテンプレートのコピー |
| lib/templates/rails/ | Rubyファイル | Railsテンプレートのコピー |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 出力先 | lib/templates/ |
| ディレクトリ構造 | erb/{controller,mailer,scaffold}/, rails/{controller,helper,scaffold_controller}/ |
| 上書き | 既存ファイルは上書きされる |

コピーされるディレクトリ構造：
```
lib/templates/
├── erb/
│   ├── controller/
│   │   └── templates/
│   ├── mailer/
│   │   └── templates/
│   └── scaffold/
│       └── templates/
└── rails/
    ├── controller/
    │   └── templates/
    ├── helper/
    │   └── templates/
    └── scaffold_controller/
        └── templates/
```

## 処理フロー

### 処理シーケンス

```
1. generators_libパスの取得
   └─ railties内のgeneratorsディレクトリパスを取得
2. project_templatesパスの設定
   └─ #{Rails.root}/lib/templates
3. ERBテンプレートのコピー
   └─ controller, mailer, scaffoldの各テンプレートディレクトリをコピー
4. Railsテンプレートのコピー
   └─ controller, helper, scaffold_controllerの各テンプレートディレクトリをコピー
5. 処理完了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[generators_libパス取得]
    B --> C[lib/templates/erbディレクトリ作成]
    C --> D[erb/controller/templatesをコピー]
    D --> E[erb/mailer/templatesをコピー]
    E --> F[erb/scaffold/templatesをコピー]
    F --> G[lib/templates/railsディレクトリ作成]
    G --> H[rails/controller/templatesをコピー]
    H --> I[rails/helper/templatesをコピー]
    I --> J[rails/scaffold_controller/templatesをコピー]
    J --> K[バッチ正常終了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | ファイルシステムエラー | ディスク容量不足、権限エラー | ディスク容量と権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. lib/ディレクトリへの書き込み権限を確認
3. ディスク容量を確認
4. 必要に応じて手動でディレクトリを作成

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約20-30ファイル |
| 目標処理時間 | 1秒未満 |
| メモリ使用量上限 | 通常のRails起動メモリ内 |

## 排他制御

排他制御は不要ですが、同時実行は推奨されません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 標準出力なし（verbose: false） |

## 監視・アラート

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

## 備考

- コピーされるテンプレートの種類：
  - **erb/controller**: コントローラーアクション用のERBビュー
  - **erb/mailer**: メーラー用のERBビュー
  - **erb/scaffold**: Scaffold用のERBビュー（index, show, new, edit, _form等）
  - **rails/controller**: コントローラークラスのRubyテンプレート
  - **rails/helper**: ヘルパーモジュールのRubyテンプレート
  - **rails/scaffold_controller**: Scaffoldコントローラーのルビーテンプレート
- 既存のローカルテンプレートがある場合は上書きされるため、カスタマイズ済みの場合は事前にバックアップを取ることを推奨
- `mkdir_p`と`cp_r`は`verbose: false`で実行されるため、標準出力はありません
- コピー後、テンプレートファイルを編集することでジェネレーターの出力をカスタマイズできます
