# バッチ設計書 19-app:update:bin

## 概要

本ドキュメントは、Railsフレームワークに含まれるRakeタスク `app:update:bin` の設計仕様を記載したものです。このタスクはRailsエンジンの`bin/`ディレクトリに新しい実行ファイルを追加します。

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

このバッチは、Railsエンジン（プラグイン）の`bin/`ディレクトリに必要な実行ファイルを生成または更新します。`Rails::Engine::Updater`クラスを使用して、`PluginGenerator`の`create_bin_files`メソッドを呼び出します。

**業務上の目的・背景**：Railsエンジン開発において、`bin/`ディレクトリには`rails`や`test`などの実行ファイルが必要です。新しいバージョンのRailsでは追加の実行ファイルが必要になることがあり、このタスクを使用することでエンジンのbinファイルを最新の構成に更新できます。これにより、エンジン開発者は最新のRails機能をエンジン内で利用できるようになります。

**バッチの実行タイミング**：`app:update`タスクの一部として実行されるか、単独で手動実行されます。Railsアップグレード後やエンジンの初期セットアップ時に使用されます。

**主要な処理内容**：
1. `Rails::Engine::Updater`クラスをrequire
2. `Updater.run(:create_bin_files)`を実行
3. `PluginGenerator`によるbinファイルの生成

**前後の処理との関連**：このタスクは`app:update`タスクの依存タスクとして設定されています。`app:update`を実行すると自動的にこのタスクも実行されます。

**影響範囲**：エンジンの`bin/`ディレクトリ内のファイルに限定されます。既存のbinファイルは上書きされる可能性があります。

## バッチ種別

環境構築 / ファイル生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行またはapp:updateから呼び出し） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bin/rails app:update:bin）またはapp:updateタスク |

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Rails::Generators::PluginGenerator | Ruby Class | binファイルテンプレート |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

生成される主なファイル：
- `bin/rails` - Railsコマンド実行用
- `bin/test` - テスト実行用

## 処理フロー

### 処理シーケンス

```
1. Rails::Engine::Updaterのrequire
   └─ rails/engine/updater をロード
2. PluginGeneratorの初期化
   └─ engine: trueオプションで初期化
   └─ destination_rootをENGINE_ROOTに設定
3. create_bin_filesアクションの実行
   └─ generator.public_send(:create_bin_files)
4. binファイルの生成
   └─ テンプレートからbinファイルを生成
5. 処理完了
```

### フローチャート

```mermaid
flowchart TD
    A[app:update:bin開始] --> B[Rails::Engine::Updater require]
    B --> C[PluginGenerator初期化]
    C --> D[create_bin_filesアクション実行]
    D --> E[bin/ディレクトリにファイル生成]
    E --> F{ファイル存在?}
    F -->|新規| G[createとして出力]
    F -->|既存同一| H[identicalとして出力]
    F -->|既存異なる| I[conflictまたはforce]
    G --> J[バッチ正常終了]
    H --> J
    I --> J
```

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. ENGINE_ROOTが正しく設定されているか確認
3. bin/ディレクトリへの書き込み権限を確認
4. 既存ファイルとの競合がある場合は手動で解決

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | create bin/rails / identical bin/rails 等 |

## 監視・アラート

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

## 備考

- このタスクは`app:update`タスクの一部として実行されることが多いですが、単独でも実行可能です
- `Rails::Engine::Updater`は内部的に`PluginGenerator`のインスタンスを作成します
- PluginGeneratorは以下のオプションで初期化されます：
  - 引数: `["plugin"]`
  - オプション: `{ engine: true }`
  - 追加オプション: `{ destination_root: ENGINE_ROOT }`
- ファイル生成時の動作：
  - 新規ファイル: `create` メッセージを表示して作成
  - 既存で同一内容: `identical` メッセージを表示してスキップ
  - 既存で異なる内容: `conflict` メッセージを表示（設定により上書きまたはスキップ）
- エンジン内のdummyアプリケーション（test/dummy）ではなく、エンジン本体のbin/ディレクトリが対象です
