# バッチ設計書 18-app:update

## 概要

本ドキュメントは、Railsフレームワークに含まれるRakeタスク `app:update` の設計仕様を記載したものです。このタスクはRailsエンジン（プラグイン）の初期生成ファイルを最新バージョンに更新します。

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

このバッチは、Railsエンジン開発時に使用されるタスクで、エンジンの`bin/`ディレクトリに新しい実行ファイルを追加するための更新処理を実行します。`app:update:bin`タスクを依存タスクとして呼び出します。

**業務上の目的・背景**：Railsエンジン（プラグイン）を開発している場合、新しいバージョンのRailsでは`bin/`ディレクトリに新しい実行ファイルが追加されることがあります。このタスクを使用することで、エンジンのbinファイルを最新の状態に更新し、新しいRailsバージョンとの互換性を維持できます。Railsのアップグレード後に実行することで、エンジンの構成を最新化できます。

**バッチの実行タイミング**：Railsエンジンのアップグレード時や、新しいバージョンのRailsに対応する際に手動で実行されます。通常のアプリケーション開発ではなく、エンジン開発時に使用されます。

**主要な処理内容**：
1. `app:update:bin`タスクを呼び出し
2. Rails::Engine::Updater.run(:create_bin_files)を実行
3. エンジンの`bin/`ディレクトリに必要なファイルを生成

**前後の処理との関連**：このタスクは`app:update:bin`タスクを依存タスクとして持ちます。エンジン固有のRakeファイル（ENGINE_RAKEFILE）が読み込まれた環境で実行されます。

**影響範囲**：エンジンの`bin/`ディレクトリ内のファイルに限定されます。

## バッチ種別

環境構築 / アップグレード

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行、Railsアップグレード時） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bin/rails app:update） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsエンジン | Railsエンジン（プラグイン）のプロジェクト内で実行すること |
| APP_RAKEFILE | エンジンのRakeファイルが定義されていること |
| ENGINE_ROOT | エンジンのルートディレクトリが設定されていること |

### 実行可否判定

エンジン環境として正しく設定されていれば実行可能です。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Rails::Generators::PluginGenerator | Ruby Class | エンジン用ジェネレーター |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| bin/ | 実行ファイル | エンジンの実行ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 出力先 | ENGINE_ROOT/bin/ |
| ファイル種別 | Rubyスクリプト |
| 実行権限 | 755 |

## 処理フロー

### 処理シーケンス

```
1. load_appタスクの実行
   └─ APP_RAKEFILEをロード
2. app:updateタスクの開始
   └─ app:update:binを依存タスクとして実行
3. app:update:binの実行
   └─ Rails::Engine::Updaterをrequire
   └─ Rails::Engine::Updater.run(:create_bin_files)を実行
4. PluginGeneratorによるファイル生成
   └─ bin/ディレクトリに必要なファイルを作成
5. 処理完了
```

### フローチャート

```mermaid
flowchart TD
    A[app:update開始] --> B[app:update:bin呼び出し]
    B --> C[Rails::Engine::Updater require]
    C --> D[Updater.run create_bin_files]
    D --> E[PluginGenerator起動]
    E --> F[binファイル生成/更新]
    F --> G[バッチ正常終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | 環境エラー | ENGINE_ROOTが未定義 | エンジンプロジェクト内で実行 |
| なし | ファイルエラー | 書き込み権限エラー | bin/ディレクトリの権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. エンジンプロジェクト内で実行しているか確認
3. bin/ディレクトリへの書き込み権限を確認

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | ジェネレーターの出力（create/identical等） |

## 監視・アラート

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

## 備考

- このタスクはRailsアプリケーションではなく、Railsエンジン（プラグイン）開発時に使用されます
- APP_RAKEFILEはエンジン内の`test/dummy/Rakefile`を指すことが一般的です
- ENGINE_ROOTはエンジンのルートディレクトリを示し、find_engine_path関数により自動検出されます
- Rails::Engine::Updaterは内部的にPluginGeneratorを使用してファイルを生成します
- 生成されるbinファイルの例：`bin/rails`、`bin/test`等
